Repository navigation
Expand file tree
/
Copy pathStringClassNameToClassConstantRector.php
More file actions
168 lines (140 loc) · 4.09 KB
/
Copy pathStringClassNameToClassConstantRector.php
File metadata and controls
168 lines (140 loc) · 4.09 KB
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
<?php
declare(strict_types=1);
namespace Rector\Php55\Rector\String_;
use Deprecated;
use PhpParser\Node;
use PhpParser\Node\Expr\ClassConstFetch;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Scalar\String_;
use PHPStan\Reflection\ReflectionProvider;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use Webmozart\Assert\Assert;
/**
* @see \Rector\Tests\Php55\Rector\String_\StringClassNameToClassConstantRector\StringClassNameToClassConstantRectorTest
*/
final class StringClassNameToClassConstantRector extends AbstractRector implements MinPhpVersionInterface, ConfigurableRectorInterface
{
#[Deprecated(message: 'since 2.2.12. Default behavior now.')]
public const string SHOULD_KEEP_PRE_SLASH = 'should_keep_pre_slash';
/**
* @var string[]
*/
private array $classesToSkip = [];
public function __construct(
private readonly ReflectionProvider $reflectionProvider,
) {
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Replace string class names by `<class>::class` constant', [
new ConfiguredCodeSample(
<<<'CODE_SAMPLE'
class AnotherClass
{
}
class SomeClass
{
public function run()
{
return 'AnotherClass';
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class AnotherClass
{
}
class SomeClass
{
public function run()
{
return \AnotherClass::class;
}
}
CODE_SAMPLE
,
['ClassName', 'AnotherClassName'],
),
]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [String_::class];
}
/**
* @param String_ $node
*/
public function refactor(Node $node): ClassConstFetch|null
{
if ($this->shouldSkipIsA($node)) {
return null;
}
$classLikeName = $node->value;
// remove leading slash
$classLikeName = ltrim($classLikeName, '\\');
if ($classLikeName === '') {
return null;
}
if ($this->shouldSkip($classLikeName)) {
return null;
}
$fullyQualified = new FullyQualified($classLikeName);
return new ClassConstFetch($fullyQualified, 'class');
}
/**
* @param array<string, mixed> $configuration
*/
public function configure(array $configuration): void
{
Assert::allString($configuration);
$this->classesToSkip = $configuration;
}
public function provideMinPhpVersion(): int
{
return PhpVersionFeature::CLASSNAME_CONSTANT;
}
private function shouldSkip(string $classLikeName): bool
{
// skip short class names, mostly invalid use of strings
if (! str_contains($classLikeName, '\\')) {
return true;
}
// possibly string
if (ctype_lower($classLikeName[0])) {
return true;
}
if (! $this->reflectionProvider->hasClass($classLikeName)) {
return true;
}
foreach ($this->classesToSkip as $classToSkip) {
if (str_contains($classToSkip, '*')) {
if (fnmatch($classToSkip, $classLikeName, FNM_NOESCAPE)) {
return true;
}
continue;
}
if ($this->nodeNameResolver->isStringName($classLikeName, $classToSkip)) {
return true;
}
}
return false;
}
private function shouldSkipIsA(String_ $string): bool
{
if (! $string->getAttribute(AttributeKey::IS_ARG_VALUE, false)) {
return false;
}
$funcCallName = $string->getAttribute(AttributeKey::FROM_FUNC_CALL_NAME);
return $funcCallName === 'is_a';
}
}