ForbiddenDependencyByTypeRule.php

<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\Rules;

use PhpParser\Node;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Analyser\Scope;
use Symplify\Astral\Naming\SimpleNameResolver;
use Symplify\PackageBuilder\ValueObject\MethodName;
use Symplify\RuleDocGenerator\Contract\ConfigurableRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Symplify\PHPStanRules\Tests\Rules\ForbiddenDependencyByTypeRule\ForbiddenDependencyByTypeRuleTest
 */
final class ForbiddenDependencyByTypeRule extends AbstractSymplifyRule implements ConfigurableRuleInterface
{
    /**
     * @var string
     */
    public const ERROR_MESSAGE = 'Object instance of "%s" is forbidden to be passed to constructor';

    /**
     * @var string[]
     */
    private array $forbiddenTypes = [];

    /**
     * @param string[] $forbiddenTypes
     */
    public function __construct(
        private SimpleNameResolver $simpleNameResolver,
        array $forbiddenTypes = []
    ) {
        $this->forbiddenTypes = $forbiddenTypes;
    }

    /**
     * @return array<class-string<Node>>
     */
    public function getNodeTypes(): array
    {
        return [ClassMethod::class];
    }

    /**
     * @param ClassMethod $node
     * @return string[]
     */
    public function process(Node $node, Scope $scope): array
    {
        if ($scope->getClassReflection() === null) {
            return [];
        }

        if (! $this->simpleNameResolver->isName($node->name, MethodName::CONSTRUCTOR)) {
            return [];
        }

        $params = $node->params;
        foreach ($params as $param) {
            if (! $param->type instanceof Name) {
                continue;
            }

            $paramType = $param->type->toString();
            $forbiddenType = $this->getForbiddenType($paramType);
            if ($forbiddenType === null) {
                continue;
            }

            return [sprintf(self::ERROR_MESSAGE, $forbiddenType)];
        }

        return [];
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(self::ERROR_MESSAGE, [
            new ConfiguredCodeSample(
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function __construct(EntityManager $entityManager)
    {
        // ...
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function __construct(ProductRepository $productRepository)
    {
        // ...
    }
}
CODE_SAMPLE
                ,
                [
                    'forbiddenTypes' => ['EntityManager'],
                ]
            ),
        ]);
    }

    private function getForbiddenType(string $paramType): ?string
    {
        foreach ($this->forbiddenTypes as $forbiddenType) {
            if (is_a($paramType, $forbiddenType, true)) {
                return $forbiddenType;
            }
        }

        return null;
    }
}