CallToDeprecatedFunctionRule.php

<?php declare(strict_types = 1);

namespace PHPStan\Rules\Deprecations;

use PhpParser\Node;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Name;
use PHPStan\Analyser\Scope;
use PHPStan\Broker\FunctionNotFoundException;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use function sprintf;

/**
 * @implements Rule<FuncCall>
 */
class CallToDeprecatedFunctionRule implements Rule
{

	private ReflectionProvider $reflectionProvider;

	private DeprecatedScopeHelper $deprecatedScopeHelper;

	private DeprecationHelper $deprecationHelper;

	public function __construct(ReflectionProvider $reflectionProvider, DeprecatedScopeHelper $deprecatedScopeHelper, DeprecationHelper $deprecationHelper)
	{
		$this->reflectionProvider = $reflectionProvider;
		$this->deprecatedScopeHelper = $deprecatedScopeHelper;
		$this->deprecationHelper = $deprecationHelper;
	}

	public function getNodeType(): string
	{
		return FuncCall::class;
	}

	public function processNode(Node $node, Scope $scope): array
	{
		if ($this->deprecatedScopeHelper->isScopeDeprecated($scope)) {
			return [];
		}

		if (!($node->name instanceof Name)) {
			return [];
		}

		try {
			$function = $this->reflectionProvider->getFunction($node->name, $scope);
		} catch (FunctionNotFoundException $e) {
			// Other rules will notify if the function is not found
			return [];
		}

		$deprecation = $this->deprecationHelper->getDeprecation($function);
		if ($deprecation !== null) {
			$description = $deprecation->getDescription();
			if ($description === null) {
				return [
					RuleErrorBuilder::message(sprintf(
						'Call to deprecated function %s().',
						$function->getName(),
					))->identifier('function.deprecated')->build(),
				];
			}

			return [
				RuleErrorBuilder::message(sprintf(
					"Call to deprecated function %s():\n%s",
					$function->getName(),
					$description,
				))->identifier('function.deprecated')->build(),
			];
		}

		return [];
	}

}