mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-22 17:02:03 +02:00
Code Issues Projects Releases Wiki Activity

MDL-80677 core: Any feature of a deprecated class should emit

Browse Source
This commit is contained in:
Andrew Nicols 2024-01-29 10:51:02 +08:00
parent d6112c0bfb
commit 807da4963b
No known key found for this signature in database
GPG Key ID: 6D1E3157C8CFBF14
3 changed files with 114 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/classes/deprecation.php
View File

@ -140,9 +140,10 @@ class deprecation {
\ReflectionClass $rc,
?string $name,
): ?deprecated_with_reference {
if ($name === null) {
// No name specified. This may be a deprecated class.
return self::get_attribute($rc, $rc->name);
// Check if the class itself is deprecated first.
$classattribute = self::get_attribute($rc, $rc->name);
if ($classattribute || $name === null) {
return $classattribute;
}
if ($rc->hasConstant($name)) {

103
lib/tests/deprecation_test.php
View File

@ -227,26 +227,47 @@ class deprecation_test extends \advanced_testcase {
[\core\fixtures\not_deprecated_class::class, false],
[[\core\fixtures\not_deprecated_class::class], false],
// Class properties.
// Class properties in a deprecated class.
[\core\fixtures\deprecated_class::class . '::deprecatedproperty', true],
[[\core\fixtures\deprecated_class::class, 'deprecatedproperty'], true],
[\core\fixtures\deprecated_class::class . '::notdeprecatedproperty', false],
[[\core\fixtures\deprecated_class::class, 'notdeprecatedproperty'], false],
[\core\fixtures\deprecated_class::class . '::notdeprecatedproperty', true],
[[\core\fixtures\deprecated_class::class, 'notdeprecatedproperty'], true],
// Class constants.
// Class constants in a deprecated class.
[\core\fixtures\deprecated_class::class . '::DEPRECATED_CONST', true],
[[\core\fixtures\deprecated_class::class, 'DEPRECATED_CONST'], true],
[\core\fixtures\deprecated_class::class . '::NOT_DEPRECATED_CONST', false],
[[\core\fixtures\deprecated_class::class, 'NOT_DEPRECATED_CONST'], false],
[\core\fixtures\deprecated_class::class . '::NOT_DEPRECATED_CONST', true],
[[\core\fixtures\deprecated_class::class, 'NOT_DEPRECATED_CONST'], true],
// Class methods.
// Class methods in a deprecated class.
[\core\fixtures\deprecated_class::class . '::deprecated_method', true],
[[\core\fixtures\deprecated_class::class, 'deprecated_method'], true],
[\core\fixtures\deprecated_class::class . '::not_deprecated_method', false],
[[\core\fixtures\deprecated_class::class, 'not_deprecated_method'], false],
[\core\fixtures\deprecated_class::class . '::not_deprecated_method', true],
[[\core\fixtures\deprecated_class::class, 'not_deprecated_method'], true],
// Class properties in a not-deprecated class.
[\core\fixtures\not_deprecated_class::class . '::deprecatedproperty', true],
[[\core\fixtures\not_deprecated_class::class, 'deprecatedproperty'], true],
[\core\fixtures\not_deprecated_class::class . '::notdeprecatedproperty', false],
[[\core\fixtures\not_deprecated_class::class, 'notdeprecatedproperty'], false],
// Class constants in a not-deprecated class.
[\core\fixtures\not_deprecated_class::class . '::DEPRECATED_CONST', true],
[[\core\fixtures\not_deprecated_class::class, 'DEPRECATED_CONST'], true],
[\core\fixtures\not_deprecated_class::class . '::NOT_DEPRECATED_CONST', false],
[[\core\fixtures\not_deprecated_class::class, 'NOT_DEPRECATED_CONST'], false],
// Class methods in a not-deprecated class.
[\core\fixtures\not_deprecated_class::class . '::deprecated_method', true],
[[\core\fixtures\not_deprecated_class::class, 'deprecated_method'], true],
[\core\fixtures\not_deprecated_class::class . '::not_deprecated_method', false],
[[\core\fixtures\not_deprecated_class::class, 'not_deprecated_method'], false],
// Non-existent class.
['non_existent_class', false],
@ -263,4 +284,68 @@ class deprecation_test extends \advanced_testcase {
['core\fixtures\not_deprecated_function', false],
];
}
/**
* @dataProvider deprecated_ownership_provider
*/
public function test_deprecated_class(
array $reference,
string $expectedowner,
): void {
require_once(dirname(__FILE__) . '/fixtures/deprecated_fixtures.php');
// All attributes for any part of a deprecated class should belong to the deprecated class.
$this->assertEquals(
$expectedowner,
deprecation::from($reference)->owner,
);
}
public static function deprecated_ownership_provider(): array {
return [
// Any part of a deprecated class will emit the deprecation for the class as a whole.
[
[\core\fixtures\deprecated_class::class],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'deprecatedproperty'],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'notdeprecatedproperty'],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'deprecated_method'],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'not_deprecated_method'],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'DEPRECATED_CONST'],
\core\fixtures\deprecated_class::class,
],
[
[\core\fixtures\deprecated_class::class, 'NOT_DEPRECATED_CONST'],
\core\fixtures\deprecated_class::class,
],
// A non-deprecated class will emit just for that feature.
[
[\core\fixtures\not_deprecated_class::class, 'deprecatedproperty'],
\core\fixtures\not_deprecated_class::class . '::deprecatedproperty',
],
[
[\core\fixtures\not_deprecated_class::class, 'deprecated_method'],
\core\fixtures\not_deprecated_class::class . '::deprecated_method',
],
[
[\core\fixtures\not_deprecated_class::class, 'DEPRECATED_CONST'],
\core\fixtures\not_deprecated_class::class . '::DEPRECATED_CONST',
],
];
}
}

16
lib/tests/fixtures/deprecated_fixtures.php vendored
View File

@ -47,6 +47,22 @@ class deprecated_class {
}
class not_deprecated_class {
protected string $notdeprecatedproperty = 'Not deprecated property';
#[deprecated('$this->notdeprecatedproperty')]
protected string $deprecatedproperty = 'Deprecated property';
const NOT_DEPRECATED_CONST = 'Not deprecated const';
#[deprecated('self::NOT_DEPRECATED_CONST')]
const DEPRECATED_CONST = 'Deprecated const';
public function not_deprecated_method() {
}
#[deprecated('$this->not_deprecated_method()')]
public function deprecated_method() {
}
}
function not_deprecated_function() {