TypeHintDeprecatedInFunctionSignatureRule.php

<?php

declare (strict_types=1);
namespace PHPStan\Rules\Deprecations;

use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Node\InFunctionNode;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\ShouldNotHappenException;
use function sprintf;
use function strtolower;

/**
 * @implements Rule<InFunctionNode>
 */
class TypeHintDeprecatedInFunctionSignatureRule implements Rule {
    
    /** @var DeprecatedClassHelper */
    private $deprecatedClassHelper;
    
    /** @var DeprecatedScopeHelper */
    private $deprecatedScopeHelper;
    public function __construct(DeprecatedClassHelper $deprecatedClassHelper, DeprecatedScopeHelper $deprecatedScopeHelper) {
        $this->deprecatedClassHelper = $deprecatedClassHelper;
        $this->deprecatedScopeHelper = $deprecatedScopeHelper;
    }
    public function getNodeType() : string {
        return InFunctionNode::class;
    }
    public function processNode(Node $node, Scope $scope) : array {
        if ($this->deprecatedScopeHelper
            ->isScopeDeprecated($scope)) {
            return [];
        }
        $function = $scope->getFunction();
        if ($function === null) {
            throw new ShouldNotHappenException();
        }
        $functionSignature = ParametersAcceptorSelector::selectSingle($function->getVariants());
        $errors = [];
        foreach ($functionSignature->getParameters() as $parameter) {
            $deprecatedClasses = $this->deprecatedClassHelper
                ->filterDeprecatedClasses($parameter->getType()
                ->getReferencedClasses());
            foreach ($deprecatedClasses as $deprecatedClass) {
                $errors[] = RuleErrorBuilder::message(sprintf('Parameter $%s of function %s() has typehint with deprecated %s %s%s', $parameter->getName(), $function->getName(), strtolower($deprecatedClass->getClassTypeDescription()), $deprecatedClass->getName(), $this->deprecatedClassHelper
                    ->getClassDeprecationDescription($deprecatedClass)))
                    ->identifier(sprintf('parameter.deprecated%s', $deprecatedClass->getClassTypeDescription()))
                    ->build();
            }
        }
        $deprecatedClasses = $this->deprecatedClassHelper
            ->filterDeprecatedClasses($functionSignature->getReturnType()
            ->getReferencedClasses());
        foreach ($deprecatedClasses as $deprecatedClass) {
            $errors[] = RuleErrorBuilder::message(sprintf('Return type of function %s() has typehint with deprecated %s %s%s', $function->getName(), strtolower($deprecatedClass->getClassTypeDescription()), $deprecatedClass->getName(), $this->deprecatedClassHelper
                ->getClassDeprecationDescription($deprecatedClass)))
                ->identifier(sprintf('return.deprecated%s', $deprecatedClass->getClassTypeDescription()))
                ->build();
        }
        return $errors;
    }

}