-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
NoTrailingCommaInSinglelineFunctionCallFixer.php
112 lines (94 loc) · 3.57 KB
/
NoTrailingCommaInSinglelineFunctionCallFixer.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
<?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\FunctionNotation;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\AttributeAnalyzer;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Tokens;
final class NoTrailingCommaInSinglelineFunctionCallFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*/
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument.',
[new CodeSample("<?php\nfoo(\$a,);\n")]
);
}
/**
* {@inheritdoc}
*
* Must run before NoSpacesInsideParenthesisFixer.
*/
public function getPriority(): int
{
return 3;
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isAnyTokenKindsFound([T_STRING, T_VARIABLE, T_CLASS, T_UNSET, T_ISSET, T_LIST]);
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
for ($index = \count($tokens) - 1; $index > 0; --$index) {
if (!$tokens[$index]->equals(')')) {
continue;
}
$trailingCommaIndex = $tokens->getPrevMeaningfulToken($index);
if (!$tokens[$trailingCommaIndex]->equals(',')) {
continue;
}
$callIndex = $tokens->getPrevMeaningfulToken( // get before "parenthesis open index"
$tokens->findBlockStart(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $index)
);
if ($tokens[$callIndex]->isGivenKind([T_VARIABLE, T_CLASS, T_UNSET, T_ISSET, T_LIST])) {
$this->clearCommaIfNeeded($tokens, $callIndex, $index, $trailingCommaIndex);
continue;
}
if ($tokens[$callIndex]->isGivenKind(T_STRING)) {
if (!AttributeAnalyzer::isAttribute($tokens, $callIndex)) {
$this->clearCommaIfNeeded($tokens, $callIndex, $index, $trailingCommaIndex);
}
continue;
}
if ($tokens[$callIndex]->equalsAny([')', ']', [CT::T_DYNAMIC_VAR_BRACE_CLOSE], [CT::T_ARRAY_INDEX_CURLY_BRACE_CLOSE]])) {
$block = Tokens::detectBlockType($tokens[$callIndex]);
if (
Tokens::BLOCK_TYPE_ARRAY_INDEX_CURLY_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_DYNAMIC_VAR_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_INDEX_SQUARE_BRACE === $block['type']
|| Tokens::BLOCK_TYPE_PARENTHESIS_BRACE === $block['type']
) {
$this->clearCommaIfNeeded($tokens, $callIndex, $index, $trailingCommaIndex);
// continue; implicit
}
}
}
}
private function clearCommaIfNeeded(Tokens $tokens, int $startIndex, int $endIndex, int $commaIndex): void
{
if (!$tokens->isPartialCodeMultiline($startIndex, $endIndex)) {
$tokens->clearTokenAndMergeSurroundingWhitespace($commaIndex);
}
}
}