ExcessiveParameterListRule.php

<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\Rules;

use PhpParser\Node;
use PhpParser\Node\Expr\ArrowFunction;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PHPStan\Analyser\Scope;
use Symplify\RuleDocGenerator\Contract\ConfigurableRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * @see \Symplify\PHPStanRules\Tests\Rules\ExcessiveParameterListRule\ExcessiveParameterListRuleTest
 */
final class ExcessiveParameterListRule extends AbstractSymplifyRule implements ConfigurableRuleInterface
{
    /**
     * @var string
     */
    public const ERROR_MESSAGE = 'Method "%s()" is using too many parameters - %d. Make it under %d';

    public function __construct(
        private int $maxParameterCount = 10
    ) {
    }

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

    /**
     * @param FunctionLike $node
     * @return string[]
     */
    public function process(Node $node, Scope $scope): array
    {
        $currentParameterCount = count($node->getParams());
        if ($currentParameterCount <= $this->maxParameterCount) {
            return [];
        }

        $name = $this->resolveName($node);
        $message = sprintf(self::ERROR_MESSAGE, $name, $currentParameterCount, $this->maxParameterCount);
        return [$message];
    }

    public function getRuleDefinition(): RuleDefinition
    {
        return new RuleDefinition(self::ERROR_MESSAGE, [
            new ConfiguredCodeSample(
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function __construct($one, $two, $three)
    {
        // ...
    }
}
CODE_SAMPLE
                ,
                <<<'CODE_SAMPLE'
class SomeClass
{
    public function __construct($one, $two)
    {
        // ...
    }
}
CODE_SAMPLE
                ,
                [
                    'maxParameterCount' => 2,
                ]
            ),
        ]);
    }

    private function resolveName(FunctionLike $functionLike): string
    {
        if ($functionLike instanceof ClassMethod) {
            return (string) $functionLike->name;
        }
        if ($functionLike instanceof Function_) {
            return (string) $functionLike->name;
        }
        if ($functionLike instanceof ArrowFunction) {
            return 'arrow function';
        }

        if ($functionLike instanceof Closure) {
            return 'closure';
        }

        return 'unknown';
    }
}