MultiLineIfIndentationFixer.php

<?php

declare(strict_types=1);

/*
 * This file is part of Contao.
 *
 * (c) Leo Feyer
 *
 * @license LGPL-3.0-or-later
 */

namespace Contao\EasyCodingStandard\Fixer;

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;

final class MultiLineIfIndentationFixer extends AbstractFixer
{
    use IndentationFixerTrait;

    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'A multi-line if statement must be properly indented.',
            [
                new CodeSample(
                    <<<'EOT'
                        <?php

                        class Foo
                        {
                            public function bar(array $array): void
                            {
                                if (
                                    isset($array["bar"])
                                    && is_array($array["bar"])
                                ) {
                                    // do something
                                }
                            }
                        }
                        EOT,
                ),
            ],
        );
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isAnyTokenKindsFound([T_IF, T_ELSEIF]);
    }

    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        for ($index = 1, $count = \count($tokens); $index < $count; ++$index) {
            if (!$tokens[$index]->isGivenKind([T_IF, T_ELSEIF])) {
                continue;
            }

            $nextMeaningful = $tokens->getNextMeaningfulToken($index);

            if (!$tokens[$nextMeaningful]->equals('(')) {
                continue;
            }

            $indent = $this->getIndent($tokens, $index);
            $index = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $nextMeaningful);

            if (!$this->isMultiLineStatement($tokens, $nextMeaningful, $index)) {
                continue;
            }

            // Add a line-break after the opening parenthesis
            if (!$tokens[$nextMeaningful + 1]->isGivenKind(T_WHITESPACE)) {
                $tokens->insertAt($nextMeaningful + 1, new Token([T_WHITESPACE, $indent.'    ']));
                ++$index;
            }

            // Add a line-break before the closing parenthesis
            if (!$tokens[$index - 1]->isGivenKind(T_WHITESPACE)) {
                $tokens->insertAt($index, new Token([T_WHITESPACE, $indent]));
                ++$index;
            }
        }
    }
}