[PHP 8.5] Support for deprecated traits

Author: ondrejmirtes

src/Php/PhpVersion.php

@@ -454,4 +454,9 @@ public function supportsAttributesOnGlobalConstants(): bool
 		return $this->versionId >= 80500;
 	}
 
+	public function supportsDeprecatedTraits(): bool
+	{
+		return $this->versionId >= 80500;
+	}
+
 }

src/Reflection/ClassReflection.php

@@ -1434,6 +1434,12 @@ private function resolveDeprecation(): void
 			return;
 		}
 
+		if ($this->isTrait() && count($this->getNativeReflection()->getAttributes('Deprecated')) > 0) {
+			$this->isDeprecated = true;
+			$this->deprecatedDescription = null;
+			return;
+		}
+
 		$this->isDeprecated = false;
 		$this->deprecatedDescription = null;
 	}

src/Rules/Classes/ClassAttributesRule.php

@@ -12,6 +12,7 @@
 use PHPStan\Rules\RuleErrorBuilder;
 use function count;
 use function sprintf;
+use function strtolower;
 
 /**
  * @implements Rule<InClassNode>
@@ -41,6 +42,15 @@ public function processNode(Node $node, Scope $scope): array
 		);
 
 		$classReflection = $node->getClassReflection();
+
+		if (count($classReflection->getNativeReflection()->getAttributes('Deprecated')) > 0) {
+			$typeName = strtolower($classReflection->getClassTypeDescription());
+			$errors[] = RuleErrorBuilder::message(sprintf('Attribute class Deprecated cannot be used with %s %s.', $typeName, $classReflection->getDisplayName()))
+				->identifier(sprintf('%s.deprecatedAttribute', $typeName))
+				->nonIgnorable()
+				->build();
+		}
+
 		if (
 			$classReflection->isReadOnly()
 			|| $classReflection->isEnum()

src/Rules/Traits/TraitAttributesRule.php

@@ -7,6 +7,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Node\InTraitNode;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\AttributesCheck;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
@@ -21,6 +22,7 @@ final class TraitAttributesRule implements Rule
 
 	public function __construct(
 		private AttributesCheck $attributesCheck,
+		private PhpVersion $phpVersion,
 	)
 	{
 	}
@@ -40,6 +42,15 @@ public function processNode(Node $node, Scope $scope): array
 			'class',
 		);
 
+		if (!$this->phpVersion->supportsDeprecatedTraits()) {
+			if (count($node->getTraitReflection()->getNativeReflection()->getAttributes('Deprecated')) > 0) {
+				$errors[] = RuleErrorBuilder::message('Attribute class Deprecated can be used with traits only on PHP 8.5 and later.')
+					->identifier('trait.deprecatedAttribute')
+					->nonIgnorable()
+					->build();
+			}
+		}
+
 		if (count($node->getTraitReflection()->getNativeReflection()->getAttributes('AllowDynamicProperties')) > 0) {
 			$errors[] = RuleErrorBuilder::message('Attribute class AllowDynamicProperties cannot be used with trait.')
 				->identifier('trait.allowDynamicProperties')

tests/PHPStan/Reflection/ClassReflectionTest.php

@@ -7,6 +7,7 @@
 use Attributes\IsAttribute2;
 use Attributes\IsAttribute3;
 use Attributes\IsNotAttribute;
+use DeprecatedAttributeOnTrait\DeprTrait;
 use GenericInheritance\C;
 use HasTraitUse\Bar;
 use HasTraitUse\Baz;
@@ -318,4 +319,18 @@ public function testIs(): void
 		$this->assertFalse($classReflection->is(RuleTestCase::class));
 	}
 
+	public static function dataDeprecatedAttribute(): iterable
+	{
+		yield [\DeprecatedAttrOnClass\Foo::class, false];
+		yield [DeprTrait::class, true]; // @phpstan-ignore classConstant.deprecatedTrait
+	}
+
+	#[DataProvider('dataDeprecatedAttribute')]
+	public function testDeprecatedAttribute(string $className, bool $expected): void
+	{
+		$reflectionProvider = self::createReflectionProvider();
+		$classReflection = $reflectionProvider->getClass($className);
+		$this->assertSame($expected, $classReflection->isDeprecated());
+	}
+
 }

tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php

@@ -185,4 +185,22 @@ public function testBug12281(): void
 		]);
 	}
 
+	public function testDeprecatedAttribute(): void
+	{
+		$this->analyse([__DIR__ . '/data/deprecated-attr-on-class.php'], [
+			[
+				'Attribute class Deprecated cannot be used with class DeprecatedAttrOnClass\Foo.',
+				7,
+			],
+			[
+				'Attribute class Deprecated cannot be used with interface DeprecatedAttrOnClass\Bar.',
+				13,
+			],
+			[
+				'Attribute class Deprecated cannot be used with enum DeprecatedAttrOnClass\Baz.',
+				19,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Classes/data/deprecated-attr-on-class.php

@@ -0,0 +1,23 @@
+<?php // lint >= 8.1
+
+namespace DeprecatedAttrOnClass;
+
+use Deprecated;
+
+#[Deprecated]
+class Foo
+{
+
+}
+
+#[Deprecated]
+interface Bar
+{
+
+}
+
+#[Deprecated]
+enum Baz
+{
+
+}

tests/PHPStan/Rules/Traits/TraitAttributesRuleTest.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Rules\Traits;
 
+use PHPStan\Php\PhpVersion;
 use PHPStan\Rules\AttributesCheck;
 use PHPStan\Rules\ClassCaseSensitivityCheck;
 use PHPStan\Rules\ClassForbiddenNameCheck;
@@ -13,6 +14,7 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleLevelHelper;
 use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\RequiresPhp;
 use const PHP_VERSION_ID;
 
 /**
@@ -49,6 +51,7 @@ protected function getRule(): Rule
 				),
 				true,
 			),
+			new PhpVersion(PHP_VERSION_ID),
 		);
 	}
 
@@ -92,4 +95,21 @@ public function testBug12281(): void
 		]);
 	}
 
+	#[RequiresPhp('>= 8.5')]
+	public function testBugDeprecatedAttributeAllowed(): void
+	{
+		$this->analyse([__DIR__ . '/data/deprecated-attr-on-trait.php'], []);
+	}
+
+	#[RequiresPhp('< 8.5')]
+	public function testBugDeprecatedAttributeNotAllowed(): void
+	{
+		$this->analyse([__DIR__ . '/data/deprecated-attr-on-trait.php'], [
+			[
+				'Attribute class Deprecated can be used with traits only on PHP 8.5 and later.',
+				5,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Traits/data/deprecated-attr-on-trait.php

@@ -0,0 +1,16 @@
+<?php // lint >= 8.5
+
+namespace DeprecatedAttributeOnTrait;
+
+#[\Deprecated]
+trait DeprTrait
+{
+
+}
+
+class Foo
+{
+
+	use DeprTrait;
+
+}