InlinePhpdocCommentFixer.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 InlinePhpdocCommentFixer extends AbstractFixer
{
    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Inline phpDoc comments should not be converted to regular comments.',
            [
                new CodeSample(
                    <<<'EOT'
                        <?php

                        public function testFoo(): void
                        {
                            /** @var string $str */
                            $str = (new Foo())->get();
                        }
                        EOT,
                ),
            ],
        );
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isTokenKindFound(T_COMMENT);
    }

    /**
     * Must run after PhpdocToCommentFixer.
     */
    public function getPriority(): int
    {
        return 24;
    }

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

            $content = $tokens[$index]->getContent();

            if (!str_starts_with($content, '/* @') || str_contains($content, "\n")) {
                continue;
            }

            $tokens->offsetSet($index, new Token([T_DOC_COMMENT, '/** @'.substr($content, 4)]));
        }
    }
}