Listen to InClassMethodNode

Author: paxal

rules.neon

@@ -9,5 +9,5 @@ rules:
 	- PHPStan\Rules\Deprecations\InheritanceOfDeprecatedClassRule
 	- PHPStan\Rules\Deprecations\InheritanceOfDeprecatedInterfaceRule
 	- PHPStan\Rules\Deprecations\InstantiationOfDeprecatedClassRule
-	- PHPStan\Rules\Deprecations\TypeHintDeprecatedInFunctionSignatureRule
+	- PHPStan\Rules\Deprecations\TypeHintDeprecatedInClassMethodSignatureRule
 	- PHPStan\Rules\Deprecations\UsageOfDeprecatedTraitRule

src/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRule.php

@@ -0,0 +1,103 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Broker\Broker;
+use PHPStan\Node\InClassMethodNode;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParameterReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+
+class TypeHintDeprecatedInClassMethodSignatureRule implements \PHPStan\Rules\Rule
+{
+
+	/** @var Broker */
+	private $broker;
+
+	public function __construct(Broker $broker)
+	{
+		$this->broker = $broker;
+	}
+
+	public function getNodeType(): string
+	{
+		return InClassMethodNode::class;
+	}
+
+	/**
+	 * @param InClassMethodNode $node
+	 * @param \PHPStan\Analyser\Scope $scope
+	 * @return string[] errors
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		/** @var MethodReflection $method */
+		$method = $scope->getFunction();
+		if (!$method instanceof MethodReflection) {
+			throw new \PHPStan\ShouldNotHappenException();
+		}
+		$methodSignature = ParametersAcceptorSelector::selectSingle($method->getVariants());
+
+		$errorLists = [];
+		foreach ($methodSignature->getParameters() as $i => $parameter) {
+			/** @var ParameterReflection $parameter */
+			$errorLists[] = $this->checkClasses(
+				$parameter->getType()->getReferencedClasses(),
+				'argument #' . $i
+			);
+		}
+
+		$errorLists[] = $this->checkClasses(
+			$methodSignature->getReturnType()->getReferencedClasses(),
+			'return type'
+		);
+
+		return array_merge(...$errorLists);
+	}
+
+	/**
+	 * @param string[] $referencedClasses
+	 * @param string $where
+	 * @return string[]
+	 */
+	private function checkClasses(array $referencedClasses, string $where): array
+	{
+		$errors = [];
+		foreach ($referencedClasses as $referencedClass) {
+			try {
+				$class = $this->broker->getClass($referencedClass);
+			} catch (\PHPStan\Broker\ClassNotFoundException $e) {
+				continue;
+			}
+
+			if (!$class->isDeprecated()) {
+				continue;
+			}
+
+			$classDescription = null;
+			if (method_exists($class, 'getDeprecatedDescription')) {
+				$classDescription = $class->getDeprecatedDescription();
+			}
+
+			if ($classDescription === null) {
+				$errors[] = sprintf(
+					'Usage of deprecated class %s in %s.',
+					$referencedClass,
+					$where
+				);
+			} else {
+				$errors[] = sprintf(
+					"Usage of deprecated class %s in %s:\n%s",
+					$referencedClass,
+					$where,
+					$classDescription
+				);
+			}
+		}
+
+		return $errors;
+	}
+
+}

src/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRule.php

@@ -2,14 +2,14 @@
 
 namespace PHPStan\Rules\Deprecations;
 
-class TypeHintDeprecatedInFunctionSignatureRuleTest extends \PHPStan\Testing\RuleTestCase
+class TypeHintDeprecatedInClassMethodSignatureRuleTest extends \PHPStan\Testing\RuleTestCase
 {
 
 	protected function getRule(): \PHPStan\Rules\Rule
 	{
 		$broker = $this->createBroker();
 
-		return new TypeHintDeprecatedInFunctionSignatureRule($broker);
+		return new TypeHintDeprecatedInClassMethodSignatureRule($broker);
 	}
 
 	public function test(): void
@@ -18,9 +18,10 @@ public function test(): void
 		$this->analyse(
 			[__DIR__ . '/data/typehint-deprecated-class.php'],
 			[
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #0.', 10],
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #1.', 10],
-				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in return type.', 10],
+				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #0.', 13],
+				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #1.', 13],
+				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in argument #5.', 13],
+				['Usage of deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty in return type.', 13],
 			]
 		);
 	}

tests/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRuleTest.php renamed to tests/Rules/Deprecations/TypeHintDeprecatedInClassMethodSignatureRuleTest.php

@@ -7,19 +7,24 @@ class Foo
 
     private $properties;
 
+    /**
+     * @param DeprecatedProperty $property6
+     */
     public function setProperties(
         DeprecatedProperty $property,
         ?DeprecatedProperty $property2,
         $property3,
         Property $property4,
-        string $property5
+        string $property5,
+        $property6
     ): DeprecatedProperty {
         $this->properties = [
             $property,
             $property2,
             $property3,
             $property4,
             $property5,
+            $property6
         ];
 
         return $property;