Support #[Deprecated] attribute in property hooks

Author: ondrejmirtes

src/Analyser/MutatingScope.php

@@ -3004,6 +3004,8 @@ public function enterPropertyHook(
 		?Type $phpDocPropertyType,
 		array $phpDocParameterTypes,
 		?Type $throwType,
+		?string $deprecatedDescription,
+		bool $isDeprecated,
 		?string $phpDocComment,
 	): self
 	{
@@ -3059,8 +3061,8 @@ public function enterPropertyHook(
 				$realReturnType,
 				$phpDocReturnType,
 				$throwType,
-				null,
-				false,
+				$deprecatedDescription,
+				$isDeprecated,
 				false,
 				false,
 				false,

src/Analyser/NodeScopeResolver.php

@@ -1985,7 +1985,7 @@ static function (Node $node, Scope $scope) use ($nodeCallback): void {
 	/**
 	 * @return array{bool, string|null}
 	 */
-	private function getDeprecatedAttribute(Scope $scope, Node\Stmt\Function_|Node\Stmt\ClassMethod $stmt): array
+	private function getDeprecatedAttribute(Scope $scope, Node\Stmt\Function_|Node\Stmt\ClassMethod|Node\PropertyHook $stmt): array
 	{
 		$initializerExprContext = InitializerExprContext::fromStubParameter(
 			null,
@@ -4684,13 +4684,17 @@ private function processPropertyHooks(
 				$this->processParamNode($stmt, $param, $scope, $nodeCallback);
 			}
 
+			[$isDeprecated, $deprecatedDescription] = $this->getDeprecatedAttribute($scope, $hook);
+
 			$hookScope = $scope->enterPropertyHook(
 				$hook,
 				$propertyName,
 				$nativeTypeNode,
 				$phpDocType,
 				$phpDocParameterTypes,
 				$phpDocThrowType,
+				$deprecatedDescription,
+				$isDeprecated,
 				$phpDocComment,
 			);
 			$hookReflection = $hookScope->getFunction();

src/Reflection/InitializerExprContext.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Reflection;
 
+use PhpParser\Node\PropertyHook;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Function_;
 use PHPStan\Analyser\Scope;
@@ -115,7 +116,7 @@ public static function fromReflectionParameter(ReflectionParameter $parameter):
 	public static function fromStubParameter(
 		?string $className,
 		string $stubFile,
-		ClassMethod|Function_ $function,
+		ClassMethod|Function_|PropertyHook $function,
 	): self
 	{
 		$namespace = null;

tests/PHPStan/Reflection/Annotations/DeprecatedAnnotationsTest.php

@@ -339,4 +339,50 @@ public function testDeprecatedAttributeAboveEnumCase(string $className, string $
 		$this->assertSame($deprecatedDescription, $case->getDeprecatedDescription());
 	}
 
+	public function dataDeprecatedAttributeAbovePropertyHook(): iterable
+	{
+		yield [
+			\DeprecatedAttributePropertyHooks\Foo::class,
+			'i',
+			'get',
+			TrinaryLogic::createNo(),
+			null,
+		];
+		yield [
+			\DeprecatedAttributePropertyHooks\Foo::class,
+			'j',
+			'get',
+			TrinaryLogic::createYes(),
+			null,
+		];
+		yield [
+			\DeprecatedAttributePropertyHooks\Foo::class,
+			'k',
+			'get',
+			TrinaryLogic::createYes(),
+			'msg',
+		];
+		yield [
+			\DeprecatedAttributePropertyHooks\Foo::class,
+			'l',
+			'get',
+			TrinaryLogic::createYes(),
+			'msg2',
+		];
+	}
+
+	/**
+	 * @dataProvider dataDeprecatedAttributeAbovePropertyHook
+	 * @param 'get'|'set' $hookName
+	 */
+	public function testDeprecatedAttributeAbovePropertyHook(string $className, string $propertyName, string $hookName, TrinaryLogic $isDeprecated, ?string $deprecatedDescription): void
+	{
+		$reflectionProvider = $this->createReflectionProvider();
+		$class = $reflectionProvider->getClass($className);
+		$property = $class->getNativeProperty($propertyName);
+		$hook = $property->getHook($hookName);
+		$this->assertSame($isDeprecated->describe(), $hook->isDeprecated()->describe());
+		$this->assertSame($deprecatedDescription, $hook->getDeprecatedDescription());
+	}
+
 }

tests/PHPStan/Reflection/Annotations/DeprecatedAttributePhpFunctionFromParserReflectionRuleTest.php

@@ -6,6 +6,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassMethodNode;
 use PHPStan\Node\InFunctionNode;
+use PHPStan\Node\InPropertyHookNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\Testing\RuleTestCase;
@@ -18,15 +19,15 @@ class DeprecatedAttributePhpFunctionFromParserReflectionRuleTest extends RuleTes
 {
 
 	/**
-	 * @return Rule<Node\Stmt>
+	 * @return Rule<Node>
 	 */
 	protected function getRule(): Rule
 	{
-		return new /** @implements Rule<Node\Stmt> */ class implements Rule {
+		return new /** @implements Rule<Node> */ class implements Rule {
 
 			public function getNodeType(): string
 			{
-				return Node\Stmt::class;
+				return Node::class;
 			}
 
 			public function processNode(Node $node, Scope $scope): array
@@ -35,6 +36,8 @@ public function processNode(Node $node, Scope $scope): array
 					$reflection = $node->getFunctionReflection();
 				} elseif ($node instanceof InClassMethodNode) {
 					$reflection = $node->getMethodReflection();
+				} elseif ($node instanceof InPropertyHookNode) {
+					$reflection = $node->getHookReflection();
 				} else {
 					return [];
 				}
@@ -108,4 +111,26 @@ public function testMethodRule(): void
 		]);
 	}
 
+	public function testPropertyHookRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/deprecated-attribute-property-hooks.php'], [
+			[
+				'Not deprecated',
+				11,
+			],
+			[
+				'Deprecated',
+				17,
+			],
+			[
+				'Deprecated: msg',
+				24,
+			],
+			[
+				'Deprecated: msg2',
+				31,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Reflection/Annotations/data/deprecated-attribute-property-hooks.php

@@ -0,0 +1,37 @@
+<?php // lint >= 8.4
+
+namespace DeprecatedAttributePropertyHooks;
+
+use Deprecated;
+
+class Foo
+{
+
+	public int $i {
+		get {
+			return 1;
+		}
+	}
+
+	public int $j {
+		#[Deprecated]
+		get {
+			return 1;
+		}
+	}
+
+	public int $k {
+		#[Deprecated('msg')]
+		get {
+			return 1;
+		}
+	}
+
+	public int $l {
+		#[Deprecated(since: '1.0', message: 'msg2')]
+		get {
+			return 1;
+		}
+	}
+
+}