rector/rules/code-quality/src/Rector/FuncCall/CompactToVariablesRector.php

<?php

declare(strict_types=1);

namespace Rector\CodeQuality\Rector\FuncCall;

use PhpParser\Node;
use PhpParser\Node\Expr\FuncCall;
use Rector\CodeQuality\CompactConverter;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\RectorDefinition\CodeSample;
use Rector\Core\RectorDefinition\RectorDefinition;

/**
 * @see https://stackoverflow.com/a/16319909/1348344
 * @see https://3v4l.org/8GJEs
 * @see \Rector\CodeQuality\Tests\Rector\FuncCall\CompactToVariablesRector\CompactToVariablesRectorTest
 */
final class CompactToVariablesRector extends AbstractRector
{
    /**
     * @var CompactConverter
     */
    private $compactConverter;

    public function __construct(CompactConverter $compactConverter)
    {
        $this->compactConverter = $compactConverter;
    }

    public function getDefinition(): RectorDefinition
    {
        return new RectorDefinition('Change compact() call to own array', [
            new CodeSample(
                <<<'PHP'
class SomeClass
{
    public function run()
    {
        $checkout = 'one';
        $form = 'two';

        return compact('checkout', 'form');
    }
}
PHP
                ,
                <<<'PHP'
class SomeClass
{
    public function run()
    {
        $checkout = 'one';
        $form = 'two';

        return ['checkout' => $checkout, 'form' => $form];
    }
}
PHP
            ),
        ]);
    }

    /**
     * @return string[]
     */
    public function getNodeTypes(): array
    {
        return [FuncCall::class];
    }

    /**
     * @param FuncCall $node
     */
    public function refactor(Node $node): ?Node
    {
        if (! $this->isName($node, 'compact')) {
            return null;
        }

        if (! $this->compactConverter->hasAllArgumentsNamed($node)) {
            return null;
        }

        return $this->compactConverter->convertToArray($node);
    }
}