-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
PhpdocReadonlyClassCommentToKeywordFixer.php
129 lines (107 loc) · 3.7 KB
/
PhpdocReadonlyClassCommentToKeywordFixer.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?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\ClassNotation;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\FixerDefinition\VersionSpecification;
use PhpCsFixer\FixerDefinition\VersionSpecificCodeSample;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Marcel Behrmann <marcel@behrmann.dev>
*/
final class PhpdocReadonlyClassCommentToKeywordFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*
* Must run before NoEmptyPhpdocFixer, NoExtraBlankLinesFixer, PhpdocAlignFixer.
* Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
*/
public function getPriority(): int
{
return 4;
}
public function isCandidate(Tokens $tokens): bool
{
return \PHP_VERSION_ID >= 8_02_00 && $tokens->isTokenKindFound(T_DOC_COMMENT);
}
public function isRisky(): bool
{
return true;
}
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Converts readonly comment on classes to the readonly keyword.',
[
new VersionSpecificCodeSample(
<<<EOT
<?php
/** @readonly */
class C {
}\n
EOT,
new VersionSpecification(8_02_00)
),
],
null,
'If classes marked with `@readonly` annotation were extended anyway, applying this fixer may break the inheritance for their child classes.'
);
}
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());
$annotations = $doc->getAnnotationsOfType('readonly');
if (0 === \count($annotations)) {
continue;
}
foreach ($annotations as $annotation) {
$annotation->remove();
}
$mainIndex = $index;
$index = $tokens->getNextMeaningfulToken($index);
$addReadonly = true;
while ($tokens[$index]->isGivenKind([
T_ABSTRACT,
T_FINAL,
T_PRIVATE,
T_PUBLIC,
T_PROTECTED,
T_READONLY,
])) {
if ($tokens[$index]->isGivenKind([T_READONLY])) {
$addReadonly = false;
}
$index = $tokens->getNextMeaningfulToken($index);
}
if (!$tokens[$index]->isGivenKind(T_CLASS)) {
continue;
}
if ($addReadonly) {
$tokens->insertAt($index, [new Token([T_READONLY, 'readonly']), new Token([T_WHITESPACE, ' '])]);
}
$newContent = $doc->getContent();
if ('' === $newContent) {
$tokens->clearTokenAndMergeSurroundingWhitespace($mainIndex);
continue;
}
$tokens[$mainIndex] = new Token([T_DOC_COMMENT, $doc->getContent()]);
}
}
}