InstantiationOfDeprecatedClassRule.php

<?php

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

use PhpParser\Node;
use PhpParser\Node\Expr\New_;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Analyser\Scope;
use PHPStan\Broker\ClassNotFoundException;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Rules\RuleLevelHelper;
use PHPStan\Type\ErrorType;
use function sprintf;

/**
 * @implements Rule<New_>
 */
class InstantiationOfDeprecatedClassRule implements Rule {
    
    /** @var ReflectionProvider */
    private $reflectionProvider;
    
    /** @var RuleLevelHelper */
    private $ruleLevelHelper;
    
    /** @var DeprecatedScopeHelper */
    private $deprecatedScopeHelper;
    public function __construct(ReflectionProvider $reflectionProvider, RuleLevelHelper $ruleLevelHelper, DeprecatedScopeHelper $deprecatedScopeHelper) {
        $this->reflectionProvider = $reflectionProvider;
        $this->ruleLevelHelper = $ruleLevelHelper;
        $this->deprecatedScopeHelper = $deprecatedScopeHelper;
    }
    public function getNodeType() : string {
        return New_::class;
    }
    public function processNode(Node $node, Scope $scope) : array {
        if ($this->deprecatedScopeHelper
            ->isScopeDeprecated($scope)) {
            return [];
        }
        $referencedClasses = [];
        if ($node->class instanceof Name) {
            $referencedClasses[] = $scope->resolveName($node->class);
        }
        elseif ($node->class instanceof Class_) {
            if (!isset($node->class->namespacedName)) {
                return [];
            }
            $referencedClasses[] = $scope->resolveName($node->class->namespacedName);
        }
        else {
            $classTypeResult = $this->ruleLevelHelper
                ->findTypeToCheck($scope, $node->class, '', static function () : bool {
                return true;
            });
            if ($classTypeResult->getType() instanceof ErrorType) {
                return [];
            }
            $referencedClasses = $classTypeResult->getReferencedClasses();
        }
        $errors = [];
        foreach ($referencedClasses as $referencedClass) {
            try {
                $class = $this->reflectionProvider
                    ->getClass($referencedClass);
            } catch (ClassNotFoundException $e) {
                continue;
            }
            if (!$class->isDeprecated()) {
                continue;
            }
            $description = $class->getDeprecatedDescription();
            if ($description === null) {
                $errors[] = RuleErrorBuilder::message(sprintf('Instantiation of deprecated class %s.', $referencedClass))->identifier('new.deprecated')
                    ->build();
            }
            else {
                $errors[] = RuleErrorBuilder::message(sprintf("Instantiation of deprecated class %s:\n%s", $referencedClass, $description))->identifier('new.deprecated')
                    ->build();
            }
        }
        return $errors;
    }

}