Current File : /home/vacivi36/code/vendor/friendsofphp/php-cs-fixer/src/Fixer/Phpdoc/PhpdocVarWithoutNameFixer.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\Line;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Preg;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Graham Campbell <hello@gjcampbell.co.uk>
* @author Dave van der Brugge <dmvdbrugge@gmail.com>
*/
final class PhpdocVarWithoutNameFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*/
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'`@var` and `@type` annotations of classy properties should not contain the name.',
[new CodeSample('<?php
final class Foo
{
/**
* @var int $bar
*/
public $bar;
/**
* @type $baz float
*/
public $baz;
}
')]
);
}
/**
* {@inheritdoc}
*
* Must run before PhpdocAlignFixer.
* Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
*/
public function getPriority(): int
{
return 0;
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isTokenKindFound(T_DOC_COMMENT) && $tokens->isAnyTokenKindsFound([T_CLASS, T_TRAIT]);
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
foreach ($tokens as $index => $token) {
if (!$token->isGivenKind(T_DOC_COMMENT)) {
continue;
}
$nextIndex = $tokens->getNextMeaningfulToken($index);
if (null === $nextIndex) {
continue;
}
// For people writing "static public $foo" instead of "public static $foo"
if ($tokens[$nextIndex]->isGivenKind(T_STATIC)) {
$nextIndex = $tokens->getNextMeaningfulToken($nextIndex);
}
// We want only doc blocks that are for properties and thus have specified access modifiers next
$propertyModifierKinds = [T_PRIVATE, T_PROTECTED, T_PUBLIC, T_VAR];
if (\defined('T_READONLY')) { // @TODO: drop condition when PHP 8.1+ is required
$propertyModifierKinds[] = T_READONLY;
}
if (!$tokens[$nextIndex]->isGivenKind($propertyModifierKinds)) {
continue;
}
$doc = new DocBlock($token->getContent());
$firstLevelLines = $this->getFirstLevelLines($doc);
$annotations = $doc->getAnnotationsOfType(['type', 'var']);
foreach ($annotations as $annotation) {
if (isset($firstLevelLines[$annotation->getStart()])) {
$this->fixLine($firstLevelLines[$annotation->getStart()]);
}
}
$tokens[$index] = new Token([T_DOC_COMMENT, $doc->getContent()]);
}
}
private function fixLine(Line $line): void
{
$content = $line->getContent();
Preg::matchAll('/ \$[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*/', $content, $matches);
if (isset($matches[0][0])) {
$line->setContent(str_replace($matches[0][0], '', $content));
}
}
/**
* @return Line[]
*/
private function getFirstLevelLines(DocBlock $docBlock): array
{
$nested = 0;
$lines = $docBlock->getLines();
foreach ($lines as $index => $line) {
$content = $line->getContent();
if (Preg::match('/\s*\*\s*}$/', $content)) {
--$nested;
}
if ($nested > 0) {
unset($lines[$index]);
}
if (Preg::match('/\s\{$/', $content)) {
++$nested;
}
}
return $lines;
}
}
Mini Shell