Add deprecation for function typehints

Author: paxal

rules.neon

@@ -15,4 +15,5 @@ rules:
 	- PHPStan\Rules\Deprecations\InstantiationOfDeprecatedClassRule
 	- PHPStan\Rules\Deprecations\TypeHintDeprecatedInClassMethodSignatureRule
 	- PHPStan\Rules\Deprecations\TypeHintDeprecatedInClosureSignatureRule
+	- PHPStan\Rules\Deprecations\TypeHintDeprecatedInFunctionSignatureRule
 	- PHPStan\Rules\Deprecations\UsageOfDeprecatedTraitRule

src/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRule.php

@@ -0,0 +1,73 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Node\InFunctionNode;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+
+class TypeHintDeprecatedInFunctionSignatureRule implements \PHPStan\Rules\Rule
+{
+
+	/** @var DeprecatedClassHelper */
+	private $deprecatedClassHelper;
+
+	public function __construct(DeprecatedClassHelper $deprecatedClassHelper)
+	{
+		$this->deprecatedClassHelper = $deprecatedClassHelper;
+	}
+
+	public function getNodeType(): string
+	{
+		return InFunctionNode::class;
+	}
+
+	/**
+	 * @param InFunctionNode $node
+	 * @param \PHPStan\Analyser\Scope $scope
+	 * @return string[] errors
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (DeprecatedScopeHelper::isScopeDeprecated($scope)) {
+			return [];
+		}
+
+		$function = $scope->getFunction();
+		if (!$function instanceof FunctionReflection) {
+			throw new \PHPStan\ShouldNotHappenException();
+		}
+		$functionSignature = ParametersAcceptorSelector::selectSingle($function->getVariants());
+
+		$errors = [];
+		foreach ($functionSignature->getParameters() as $i => $parameter) {
+			$deprecatedClasses = $this->deprecatedClassHelper->filterDeprecatedClasses($parameter->getType()->getReferencedClasses());
+			foreach ($deprecatedClasses as $deprecatedClass) {
+				$errors[] = sprintf(
+					'Parameter $%s of function %s() has typehint with deprecated %s %s%s',
+					$parameter->getName(),
+					$function->getName(),
+					$this->deprecatedClassHelper->getClassType($deprecatedClass),
+					$deprecatedClass->getName(),
+					$this->deprecatedClassHelper->getClassDeprecationDescription($deprecatedClass)
+				);
+			}
+		}
+
+		$deprecatedClasses = $this->deprecatedClassHelper->filterDeprecatedClasses($functionSignature->getReturnType()->getReferencedClasses());
+		foreach ($deprecatedClasses as $deprecatedClass) {
+			$errors[] = sprintf(
+				'Return type of function %s() has typehint with deprecated %s %s%s',
+				$function->getName(),
+				$this->deprecatedClassHelper->getClassType($deprecatedClass),
+				$deprecatedClass->getName(),
+				$this->deprecatedClassHelper->getClassDeprecationDescription($deprecatedClass)
+			);
+		}
+
+		return $errors;
+	}
+
+}

tests/Rules/Deprecations/TypeHintDeprecatedInFunctionSignatureRuleTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+class TypeHintDeprecatedInFunctionSignatureRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function getRule(): \PHPStan\Rules\Rule
+	{
+		$broker = $this->createBroker();
+
+		return new TypeHintDeprecatedInFunctionSignatureRule(new DeprecatedClassHelper($broker));
+	}
+
+	public function test(): void
+	{
+		require_once __DIR__ . '/data/typehint-function-deprecated-class-definition.php';
+		$this->analyse(
+			[__DIR__ . '/data/typehint-function-deprecated-class.php'],
+			[
+				['Parameter $property of function TypeHintDeprecatedInFunctionSignature\setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 8],
+				['Parameter $property2 of function TypeHintDeprecatedInFunctionSignature\setProperties() has typehint with deprecated interface TypeHintDeprecatedInFunctionSignature\DeprecatedInterface.', 8],
+				["Parameter \$property4 of function TypeHintDeprecatedInFunctionSignature\setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\VerboseDeprecatedProperty:\nI'll be back", 8],
+				['Parameter $property6 of function TypeHintDeprecatedInFunctionSignature\setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 8],
+				['Return type of function TypeHintDeprecatedInFunctionSignature\setProperties() has typehint with deprecated class TypeHintDeprecatedInFunctionSignature\DeprecatedProperty.', 8],
+			]
+		);
+	}
+
+}

tests/Rules/Deprecations/data/typehint-function-deprecated-class-definition.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace TypeHintDeprecatedInFunctionSignature;
+
+/**
+ * @deprecated
+ */
+class DeprecatedProperty
+{
+
+}
+
+/**
+ * @deprecated I'll be back
+ */
+class VerboseDeprecatedProperty
+{
+
+}
+
+/**
+ * @deprecated
+ */
+interface DeprecatedInterface
+{
+
+}
+
+class Property
+{
+
+}

tests/Rules/Deprecations/data/typehint-function-deprecated-class.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace TypeHintDeprecatedInFunctionSignature;
+
+/**
+ * @param DeprecatedProperty $property6
+ */
+function setProperties(
+    DeprecatedProperty $property,
+    ?DeprecatedInterface $property2,
+    $property3,
+    VerboseDeprecatedProperty $property4,
+    string $property5,
+    $property6
+): DeprecatedProperty {
+    return $property;
+}