-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
LongToShorthandOperatorFixer.php
138 lines (113 loc) · 3.82 KB
/
LongToShorthandOperatorFixer.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
130
131
132
133
134
135
136
137
138
<?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\Operator;
use PhpCsFixer\Fixer\AbstractShortOperatorFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Tokenizer\TokensAnalyzer;
final class LongToShorthandOperatorFixer extends AbstractShortOperatorFixer
{
/**
* @var array<string, array{int, string}>
*/
private static array $operators = [
'+' => [T_PLUS_EQUAL, '+='],
'-' => [T_MINUS_EQUAL, '-='],
'*' => [T_MUL_EQUAL, '*='],
'/' => [T_DIV_EQUAL, '/='],
'&' => [T_AND_EQUAL, '&='],
'.' => [T_CONCAT_EQUAL, '.='],
'%' => [T_MOD_EQUAL, '%='],
'|' => [T_OR_EQUAL, '|='],
'^' => [T_XOR_EQUAL, '^='],
];
/**
* @var list<string>
*/
private array $operatorTypes;
private TokensAnalyzer $tokensAnalyzer;
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Shorthand notation for operators should be used if possible.',
[
new CodeSample("<?php\n\$i = \$i + 10;\n"),
],
null,
'Risky when applying for string offsets (e.g. `<?php $text = "foo"; $text[0] = $text[0] & "\x7F";`).',
);
}
/**
* {@inheritdoc}
*
* Must run before BinaryOperatorSpacesFixer, NoExtraBlankLinesFixer, NoSinglelineWhitespaceBeforeSemicolonsFixer, StandardizeIncrementFixer.
*/
public function getPriority(): int
{
return 17;
}
public function isRisky(): bool
{
return true;
}
public function isCandidate(Tokens $tokens): bool
{
if ($tokens->isAnyTokenKindsFound(array_keys(self::$operators))) {
return true;
}
// @TODO: drop condition when PHP 8.0 is required and the "&" issues went away
return \defined('T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG');
}
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
$this->operatorTypes = array_keys(self::$operators);
$this->tokensAnalyzer = new TokensAnalyzer($tokens);
parent::applyFix($file, $tokens);
}
protected function isOperatorTokenCandidate(Tokens $tokens, int $index): bool
{
if (!$tokens[$index]->equalsAny($this->operatorTypes)) {
return false;
}
while (null !== $index) {
$index = $tokens->getNextMeaningfulToken($index);
$otherToken = $tokens[$index];
if ($otherToken->equalsAny([';', [T_CLOSE_TAG]])) {
return true;
}
// fast precedence check
if ($otherToken->equals('?') || $otherToken->isGivenKind(T_INSTANCEOF)) {
return false;
}
$blockType = Tokens::detectBlockType($otherToken);
if (null !== $blockType) {
if (false === $blockType['isStart']) {
return true;
}
$index = $tokens->findBlockEnd($blockType['type'], $index);
continue;
}
// precedence check
if ($this->tokensAnalyzer->isBinaryOperator($index)) {
return false;
}
}
return false; // unreachable, but keeps SCA happy
}
protected function getReplacementToken(Token $token): Token
{
return new Token(self::$operators[$token->getContent()]);
}
}