Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. InheritanceOfDeprecatedClassRule.php

class InheritanceOfDeprecatedClassRule

@implements Rule<Class_>

Hierarchy

  • class \PHPStan\Rules\Deprecations\InheritanceOfDeprecatedClassRule implements \PHPStan\Rules\Rule

Expanded class hierarchy of InheritanceOfDeprecatedClassRule

File

vendor/phpstan/phpstan-deprecation-rules/src/Rules/Deprecations/InheritanceOfDeprecatedClassRule.php, line 17

Namespace

PHPStan\Rules\Deprecations
View source
class InheritanceOfDeprecatedClassRule implements Rule {
    
    /** @var ReflectionProvider */
    private $reflectionProvider;
    
    /** @var DeprecatedScopeHelper */
    private $deprecatedScopeHelper;
    public function __construct(ReflectionProvider $reflectionProvider, DeprecatedScopeHelper $deprecatedScopeHelper) {
        $this->reflectionProvider = $reflectionProvider;
        $this->deprecatedScopeHelper = $deprecatedScopeHelper;
    }
    public function getNodeType() : string {
        return Class_::class;
    }
    public function processNode(Node $node, Scope $scope) : array {
        if ($this->deprecatedScopeHelper
            ->isScopeDeprecated($scope)) {
            return [];
        }
        if ($node->extends === null) {
            return [];
        }
        $errors = [];
        $className = isset($node->namespacedName) ? (string) $node->namespacedName : (string) $node->name;
        try {
            $class = $this->reflectionProvider
                ->getClass($className);
        } catch (ClassNotFoundException $e) {
            return [];
        }
        $parentClassName = (string) $node->extends;
        try {
            $parentClass = $this->reflectionProvider
                ->getClass($parentClassName);
            $description = $parentClass->getDeprecatedDescription();
            if ($parentClass->isDeprecated()) {
                if (!$class->isAnonymous()) {
                    if ($description === null) {
                        $errors[] = RuleErrorBuilder::message(sprintf('Class %s extends deprecated class %s.', $className, $parentClassName))->identifier('class.extendsDeprecatedClass')
                            ->build();
                    }
                    else {
                        $errors[] = RuleErrorBuilder::message(sprintf("Class %s extends deprecated class %s:\n%s", $className, $parentClassName, $description))->identifier('class.extendsDeprecatedClass')
                            ->build();
                    }
                }
                else {
                    if ($description === null) {
                        $errors[] = RuleErrorBuilder::message(sprintf('Anonymous class extends deprecated class %s.', $parentClassName))->identifier('class.extendsDeprecatedClass')
                            ->build();
                    }
                    else {
                        $errors[] = RuleErrorBuilder::message(sprintf("Anonymous class extends deprecated class %s:\n%s", $parentClassName, $description))->identifier('class.extendsDeprecatedClass')
                            ->build();
                    }
                }
            }
        } catch (ClassNotFoundException $e) {
            // Other rules will notify if the interface is not found
        }
        return $errors;
    }

}

Members

Title Sort descending Modifiers Object type Summary
InheritanceOfDeprecatedClassRule::$deprecatedScopeHelper private property @var DeprecatedScopeHelper
InheritanceOfDeprecatedClassRule::$reflectionProvider private property @var ReflectionProvider
InheritanceOfDeprecatedClassRule::getNodeType public function
InheritanceOfDeprecatedClassRule::processNode public function
InheritanceOfDeprecatedClassRule::__construct public function
RSS feed
Powered by Drupal