Gacela\PHPStan\Rules\SuffixExtendsRule

Complexity

Total Complexity

9

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	processNode()	0	27	7
A	getNodeType()	0	3	1
A	__construct()	0	4	1

<?php

declare(strict_types=1);

namespace Gacela\PHPStan\Rules;

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Rules\Rule;

use function sprintf;

/**
 * @implements Rule<Class_>
 */
final class SuffixExtendsRule implements Rule
{
    public function __construct(
        private readonly string $suffix,
        private readonly string $expectedParent,
    ) {
    }

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

    public function processNode(Node $node, Scope $scope): array
    {
        if ($node->isAnonymous()) {

The method isAnonymous() does not exist on PhpParser\Node. It seems like you code against a sub-type of PhpParser\Node such as PhpParser\Node\Stmt\Class_.

            return [];
        }

        $classReflection = $scope->getClassReflection();
        if (!$classReflection instanceof ClassReflection) {
            return [];
        }

        $className = $classReflection->getName();
        $pos = strrpos($className, '\\');
        $shortName = $pos === false ? $className : substr($className, $pos + 1);

        if (!str_ends_with($shortName, $this->suffix)) {
            return [];
        }

        if (
            $className !== $this->expectedParent &&
            !$classReflection->isSubclassOf($this->expectedParent)
        ) {
            return [sprintf('Class %s should extend %s', $className, $this->expectedParent)];
        }

        return [];
    }
}