File Manager

✏️ Edit File: /home/rsukartini.com/rs/vendor/friendsofphp/php-cs-fixer/src/Fixer/Phpdoc/PhpdocLineSpanFixer.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Fixer\Phpdoc;

use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\Fixer\ConfigurableFixerTrait;
use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\WhitespacesAnalyzer;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\FCT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Tokenizer\TokensAnalyzer;

/**
 * @author Gert de Pagter <BackEndTea@gmail.com>
 *
 * @implements ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>
 *
 * @phpstan-type _AutogeneratedInputConfiguration array{
 *  const?: 'multi'|'single'|null,
 *  method?: 'multi'|'single'|null,
 *  property?: 'multi'|'single'|null,
 * }
 * @phpstan-type _AutogeneratedComputedConfiguration array{
 *  const: 'multi'|'single'|null,
 *  method: 'multi'|'single'|null,
 *  property: 'multi'|'single'|null,
 * }
 */
final class PhpdocLineSpanFixer extends AbstractFixer implements WhitespacesAwareFixerInterface, ConfigurableFixerInterface
{
    /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
    use ConfigurableFixerTrait;
    private const PROPERTY_PART_KINDS = [
        T_PUBLIC,
        T_PROTECTED,
        T_PRIVATE,
        T_FINAL,
        T_ABSTRACT,
        T_COMMENT,
        T_VAR,
        T_STATIC,
        T_STRING,
        T_NS_SEPARATOR,
        CT::T_ARRAY_TYPEHINT,
        CT::T_NULLABLE_TYPE,
        FCT::T_ATTRIBUTE,
        FCT::T_READONLY,
        FCT::T_PRIVATE_SET,
        FCT::T_PROTECTED_SET,
        FCT::T_PUBLIC_SET,
    ];

public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.',
            [
                new CodeSample("<?php\n\nclass Foo{\n    /** @var bool */\n    public \$var;\n}\n"),
                new CodeSample(
                    "<?php\n\nclass Foo{\n    /**\n    * @var bool\n    */\n    public \$var;\n}\n",
                    ['property' => 'single']
                ),
            ]
        );
    }

/**
     * {@inheritdoc}
     *
     * Must run before NoSuperfluousPhpdocTagsFixer, PhpdocAlignFixer.
     * Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, GeneralPhpdocAnnotationRemoveFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
     */
    public function getPriority(): int
    {
        return 7;
    }

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

protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
    {
        return new FixerConfigurationResolver([
            (new FixerOptionBuilder('const', 'Whether const blocks should be single or multi line.'))
                ->setAllowedValues(['single', 'multi', null])
                ->setDefault('multi')
                ->getOption(),
            (new FixerOptionBuilder('property', 'Whether property doc blocks should be single or multi line.'))
                ->setAllowedValues(['single', 'multi', null])
                ->setDefault('multi')
                ->getOption(),
            (new FixerOptionBuilder('method', 'Whether method doc blocks should be single or multi line.'))
                ->setAllowedValues(['single', 'multi', null])
                ->setDefault('multi')
                ->getOption(),
        ]);
    }

protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        $analyzer = new TokensAnalyzer($tokens);

foreach ($analyzer->getClassyElements() as $index => $element) {
            if (!$this->hasDocBlock($tokens, $index)) {
                continue;
            }

$type = $element['type'];

if (!isset($this->configuration[$type])) {
                continue;
            }

$docIndex = $this->getDocBlockIndex($tokens, $index);
            $doc = new DocBlock($tokens[$docIndex]->getContent());

if ('multi' === $this->configuration[$type]) {
                $doc->makeMultiLine(WhitespacesAnalyzer::detectIndent($tokens, $docIndex), $this->whitespacesConfig->getLineEnding());
            } elseif ('single' === $this->configuration[$type]) {
                $doc->makeSingleLine();
            }

$tokens->offsetSet($docIndex, new Token([T_DOC_COMMENT, $doc->getContent()]));
        }
    }

private function hasDocBlock(Tokens $tokens, int $index): bool
    {
        $docBlockIndex = $this->getDocBlockIndex($tokens, $index);

return $tokens[$docBlockIndex]->isGivenKind(T_DOC_COMMENT);
    }

private function getDocBlockIndex(Tokens $tokens, int $index): int
    {
        do {
            $index = $tokens->getPrevNonWhitespace($index);

if ($tokens[$index]->isGivenKind(CT::T_ATTRIBUTE_CLOSE)) {
                $index = $tokens->getPrevTokenOfKind($index, [[T_ATTRIBUTE]]);
            }
        } while ($tokens[$index]->isGivenKind(self::PROPERTY_PART_KINDS));

return $index;
    }
}

Batal

⬅ Naik ke Fixer 36 item

Nama	Tipe	Ukuran	Diubah	Aksi
🐘AlignMultilineCommentFixer.php	php	6.4 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘GeneralPhpdocAnnotationRemoveFixer.php	php	5.2 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘GeneralPhpdocTagRenameFixer.php	php	8 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘NoBlankLinesAfterPhpdocFixer.php	php	3 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘NoEmptyPhpdocFixer.php	php	2.9 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘NoSuperfluousPhpdocTagsFixer.php	php	24.2 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocAddMissingParamAnnotationFixer.php	php	8.7 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocAlignFixer.php	php	18.5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocAnnotationWithoutDotFixer.php	php	3.9 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocArrayTypeFixer.php	php	2.5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocIndentFixer.php	php	5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocInlineTagNormalizerFixer.php	php	4 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocLineSpanFixer.php	php	5.8 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocListTypeFixer.php	php	1.9 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocNoAccessFixer.php	php	1.7 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocNoAliasTagFixer.php	php	4.2 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocNoEmptyReturnFixer.php	php	3 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocNoPackageFixer.php	php	1.7 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocNoUselessInheritdocFixer.php	php	5.1 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocOrderByValueFixer.php	php	7.5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocOrderFixer.php	php	7.5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocParamOrderFixer.php	php	8.2 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocReturnSelfReferenceFixer.php	php	6.9 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocScalarFixer.php	php	4.8 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocSeparationFixer.php	php	10.6 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocSingleLineVarSpacingFixer.php	php	2.5 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocSummaryFixer.php	php	3 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTagCasingFixer.php	php	3.6 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTagTypeFixer.php	php	7.1 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocToCommentFixer.php	php	6.6 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTrimConsecutiveBlankLineSeparationFixer.php	php	5.4 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTrimFixer.php	php	3.3 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTypesFixer.php	php	5.8 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocTypesOrderFixer.php	php	7 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocVarAnnotationCorrectOrderFixer.php	php	2.2 KB	2025-06-30 14:15	✏️ Edit 👁️ View
🐘PhpdocVarWithoutNameFixer.php	php	4.1 KB	2025-06-30 14:15	✏️ Edit 👁️ View