/
NullableTypeDeclarationForDefaultNullValueFixer.php
169 lines (147 loc) · 5.49 KB
/
NullableTypeDeclarationForDefaultNullValueFixer.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<?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\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Analyzer\Analysis\ArgumentAnalysis;
use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author HypeMC
*/
final class NullableTypeDeclarationForDefaultNullValueFixer extends AbstractFixer implements ConfigurableFixerInterface
{
/**
* {@inheritdoc}
*/
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Adds or removes `?` before type declarations for parameters with a default `null` value.',
[
new CodeSample(
"<?php\nfunction sample(string \$str = null)\n{}\n"
),
new CodeSample(
"<?php\nfunction sample(?string \$str = null)\n{}\n",
['use_nullable_type_declaration' => false]
),
],
'Rule is applied only in a PHP 7.1+ environment.'
);
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens): bool
{
if (!$tokens->isTokenKindFound(T_VARIABLE)) {
return false;
}
if (\PHP_VERSION_ID >= 70400 && $tokens->isTokenKindFound(T_FN)) {
return true;
}
return $tokens->isTokenKindFound(T_FUNCTION);
}
/**
* {@inheritdoc}
*
* Must run before NoUnreachableDefaultArgumentValueFixer.
*/
public function getPriority(): int
{
return 1;
}
/**
* {@inheritdoc}
*/
protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
{
return new FixerConfigurationResolver([
(new FixerOptionBuilder('use_nullable_type_declaration', 'Whether to add or remove `?` before type declarations for parameters with a default `null` value.'))
->setAllowedTypes(['bool'])
->setDefault(true)
->getOption(),
]);
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
$functionsAnalyzer = new FunctionsAnalyzer();
$tokenKinds = [T_FUNCTION];
if (\PHP_VERSION_ID >= 70400) {
$tokenKinds[] = T_FN;
}
for ($index = $tokens->count() - 1; $index >= 0; --$index) {
$token = $tokens[$index];
if (!$token->isGivenKind($tokenKinds)) {
continue;
}
$arguments = $functionsAnalyzer->getFunctionArguments($tokens, $index);
$this->fixFunctionParameters($tokens, $arguments);
}
}
/**
* @param ArgumentAnalysis[] $arguments
*/
private function fixFunctionParameters(Tokens $tokens, array $arguments): void
{
$constructorPropertyModifiers = [
CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PUBLIC,
CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PROTECTED,
CT::T_CONSTRUCTOR_PROPERTY_PROMOTION_PRIVATE,
];
if (\defined('T_READONLY')) { // @TODO: drop condition when PHP 8.1+ is required
$constructorPropertyModifiers[] = T_READONLY;
}
foreach (array_reverse($arguments) as $argumentInfo) {
if (
// Skip, if the parameter
// - doesn't have a type declaration
!$argumentInfo->hasTypeAnalysis()
// type is a union
|| str_contains($argumentInfo->getTypeAnalysis()->getName(), '|')
// - a default value is not null we can continue
|| !$argumentInfo->hasDefault() || 'null' !== strtolower($argumentInfo->getDefault())
) {
continue;
}
$argumentTypeInfo = $argumentInfo->getTypeAnalysis();
if (\PHP_VERSION_ID >= 80000 && false === $this->configuration['use_nullable_type_declaration']) {
$visibility = $tokens[$tokens->getPrevMeaningfulToken($argumentTypeInfo->getStartIndex())];
if ($visibility->isGivenKind($constructorPropertyModifiers)) {
continue;
}
}
if (true === $this->configuration['use_nullable_type_declaration']) {
if (!$argumentTypeInfo->isNullable() && 'mixed' !== $argumentTypeInfo->getName()) {
$tokens->insertAt($argumentTypeInfo->getStartIndex(), new Token([CT::T_NULLABLE_TYPE, '?']));
}
} else {
if ($argumentTypeInfo->isNullable()) {
$tokens->removeTrailingWhitespace($argumentTypeInfo->getStartIndex());
$tokens->clearTokenAndMergeSurroundingWhitespace($argumentTypeInfo->getStartIndex());
}
}
}
}
}