Implement RestrictedFunctionUsageExtension

Author: ondrejmirtes

rules.neon

@@ -16,6 +16,11 @@ services:
 	-
 		class: PHPStan\Rules\Deprecations\CallWithDeprecatedIniOptionRule
 
+	-
+		class: PHPStan\Rules\Deprecations\RestrictedDeprecatedFunctionUsageExtension
+		tags:
+			- phpstan.restrictedFunctionUsageExtension
+
 	-
 		class: PHPStan\Rules\Deprecations\RestrictedDeprecatedMethodUsageExtension
 		tags:
@@ -31,7 +36,6 @@ services:
 rules:
 	- PHPStan\Rules\Deprecations\AccessDeprecatedPropertyRule
 	- PHPStan\Rules\Deprecations\AccessDeprecatedStaticPropertyRule
-	- PHPStan\Rules\Deprecations\CallToDeprecatedFunctionRule
 	- PHPStan\Rules\Deprecations\FetchingClassConstOfDeprecatedClassRule
 	- PHPStan\Rules\Deprecations\FetchingDeprecatedConstRule
 	- PHPStan\Rules\Deprecations\UsageOfDeprecatedCastRule

src/Rules/Deprecations/CallToDeprecatedFunctionRule.php

@@ -0,0 +1,55 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Deprecations;
+
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Rules\RestrictedUsage\RestrictedFunctionUsageExtension;
+use PHPStan\Rules\RestrictedUsage\RestrictedUsage;
+use function sprintf;
+
+class RestrictedDeprecatedFunctionUsageExtension implements RestrictedFunctionUsageExtension
+{
+
+	private DeprecatedScopeHelper $deprecatedScopeHelper;
+
+	public function __construct(DeprecatedScopeHelper $deprecatedScopeHelper)
+	{
+		$this->deprecatedScopeHelper = $deprecatedScopeHelper;
+	}
+
+	public function isRestrictedFunctionUsage(
+		FunctionReflection $functionReflection,
+		Scope $scope
+	): ?RestrictedUsage
+	{
+		if ($this->deprecatedScopeHelper->isScopeDeprecated($scope)) {
+			return null;
+		}
+
+		if (!$functionReflection->isDeprecated()->yes()) {
+			return null;
+		}
+
+		$description = $functionReflection->getDeprecatedDescription();
+		if ($description === null) {
+			return RestrictedUsage::create(
+				sprintf(
+					'Call to deprecated function %s().',
+					$functionReflection->getName(),
+				),
+				'function.deprecated',
+			);
+		}
+
+		return RestrictedUsage::create(
+			sprintf(
+				"Call to deprecated function %s():\n%s",
+				$functionReflection->getName(),
+				$description,
+			),
+			'function.deprecated',
+		);
+	}
+
+}

src/Rules/Deprecations/RestrictedDeprecatedFunctionUsageExtension.php

@@ -2,21 +2,19 @@
 
 namespace PHPStan\Rules\Deprecations;
 
+use PHPStan\Rules\RestrictedUsage\RestrictedFunctionUsageRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
 /**
- * @extends RuleTestCase<CallToDeprecatedFunctionRule>
+ * @extends RuleTestCase<RestrictedFunctionUsageRule>
  */
 class CallToDeprecatedFunctionRuleTest extends RuleTestCase
 {
 
 	protected function getRule(): Rule
 	{
-		return new CallToDeprecatedFunctionRule(
-			$this->createReflectionProvider(),
-			new DeprecatedScopeHelper([new DefaultDeprecatedScopeResolver()]),
-		);
+		return self::getContainer()->getByType(RestrictedFunctionUsageRule::class);
 	}
 
 	public function testDeprecatedFunctionCall(): void
@@ -41,4 +39,12 @@ public function testDeprecatedFunctionCall(): void
 		);
 	}
 
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/../../../rules.neon',
+			...parent::getAdditionalConfigFiles(),
+		];
+	}
+
 }