function ClassExtendsInternalClassRule::processNode

File

vendor/mglaman/phpstan-drupal/src/Rules/Classes/ClassExtendsInternalClassRule.php, line 34

Class

ClassExtendsInternalClassRule

@implements Rule<Class_>

Namespace

mglaman\PHPStanDrupal\Rules\Classes

Code

public function processNode(Node $node, Scope $scope) : array {
    if (!isset($node->extends)) {
        return [];
    }
    $extendedClassName = $node->extends
        ->toString();
    if (!$this->reflectionProvider
        ->hasClass($extendedClassName)) {
        return [];
    }
    $extendedClassReflection = $this->reflectionProvider
        ->getClass($extendedClassName);
    if (!$extendedClassReflection->isInternal()) {
        return [];
    }
    if (!isset($node->namespacedName)) {
        return [
            $this->buildError(null, $extendedClassName)
                ->build(),
        ];
    }
    $currentClassName = $node->namespacedName
        ->toString();
    if (!NamespaceCheck::isDrupalNamespace($node)) {
        return [
            $this->buildError($currentClassName, $extendedClassName)
                ->build(),
        ];
    }
    if (NamespaceCheck::isSharedNamespace($node)) {
        return [];
    }
    $errorBuilder = $this->buildError($currentClassName, $extendedClassName);
    if ($extendedClassName === 'Drupal\\Core\\Entity\\ContentEntityDeleteForm') {
        $errorBuilder->tip('Extend \\Drupal\\Core\\Entity\\ContentEntityConfirmFormBase. See https://www.drupal.org/node/2491057');
    }
    elseif ((string) $node->extends
        ->slice(0, 2) === 'Drupal\\Core') {
        $errorBuilder->tip('Read the Drupal core backwards compatibility and internal API policy: https://www.drupal.org/about/core/policies/core-change-policies/drupal-8-and-9-backwards-compatibility-and-internal-api#internal');
    }
    return [
        $errorBuilder->build(),
    ];
}