File Manager

✏️ Edit File: /home/rsukartini.com/rs/vendor/friendsofphp/php-cs-fixer/src/Fixer/Phpdoc/PhpdocSummaryFixer.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\DocBlock\ShortDescription;
use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;

/**
 * @author Graham Campbell <hello@gjcampbell.co.uk>
 */
final class PhpdocSummaryFixer extends AbstractFixer implements WhitespacesAwareFixerInterface
{
    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'PHPDoc summary should end in either a full stop, exclamation mark, or question mark.',
            [new CodeSample('<?php
/**
 * Foo function is great
 */
function foo () {}
')]
        );
    }

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

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

protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        foreach ($tokens as $index => $token) {
            if (!$token->isGivenKind(T_DOC_COMMENT)) {
                continue;
            }

$doc = new DocBlock($token->getContent());
            $end = (new ShortDescription($doc))->getEnd();

if (null !== $end) {
                $line = $doc->getLine($end);
                $content = rtrim($line->getContent());

if (
                    // final line of Description is NOT properly formatted
                    !$this->isCorrectlyFormatted($content)
                    // and first line  of Description, if different than final line, does NOT indicate a list
                    && (1 === $end || ($doc->isMultiLine() && ':' !== substr(rtrim($doc->getLine(1)->getContent()), -1)))
                ) {
                    $line->setContent($content.'.'.$this->whitespacesConfig->getLineEnding());
                    $tokens[$index] = new Token([T_DOC_COMMENT, $doc->getContent()]);
                }
            }
        }
    }

/**
     * Is the last line of the short description correctly formatted?
     */
    private function isCorrectlyFormatted(string $content): bool
    {
        if (str_contains(strtolower($content), strtolower('{@inheritdoc}'))) {
            return true;
        }

return $content !== rtrim($content, '.:。!?¡¿！？');
    }
}

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