-
-
Notifications
You must be signed in to change notification settings - Fork 169
/
FullyQualifiedClassNameInAnnotationSniff.php
167 lines (136 loc) · 5.19 KB
/
FullyQualifiedClassNameInAnnotationSniff.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
<?php declare(strict_types = 1);
namespace SlevomatCodingStandard\Sniffs\Namespaces;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use SlevomatCodingStandard\Helpers\Annotation\GenericAnnotation;
use SlevomatCodingStandard\Helpers\AnnotationConstantExpressionHelper;
use SlevomatCodingStandard\Helpers\AnnotationHelper;
use SlevomatCodingStandard\Helpers\AnnotationTypeHelper;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\NamespaceHelper;
use SlevomatCodingStandard\Helpers\ReferencedName;
use SlevomatCodingStandard\Helpers\TypeHelper;
use SlevomatCodingStandard\Helpers\TypeHintHelper;
use function sprintf;
use function strtolower;
use const T_DOC_COMMENT_OPEN_TAG;
class FullyQualifiedClassNameInAnnotationSniff implements Sniff
{
public const CODE_NON_FULLY_QUALIFIED_CLASS_NAME = 'NonFullyQualifiedClassName';
/**
* @return array<int, (int|string)>
*/
public function register(): array
{
return [
T_DOC_COMMENT_OPEN_TAG,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $docCommentOpenPointer
*/
public function process(File $phpcsFile, $docCommentOpenPointer): void
{
$annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer);
foreach ($annotations as $annotationName => $annotationsByName) {
foreach ($annotationsByName as $annotation) {
if ($annotation instanceof GenericAnnotation) {
continue;
}
if ($annotation->isInvalid()) {
continue;
}
foreach (AnnotationHelper::getAnnotationTypes($annotation) as $annotationType) {
foreach (AnnotationTypeHelper::getIdentifierTypeNodes($annotationType) as $typeHintNode) {
$typeHint = AnnotationTypeHelper::getTypeHintFromNode($typeHintNode);
$lowercasedTypeHint = strtolower($typeHint);
if (
TypeHintHelper::isSimpleTypeHint($lowercasedTypeHint)
|| TypeHintHelper::isSimpleUnofficialTypeHints($lowercasedTypeHint)
|| !TypeHelper::isTypeName($typeHint)
|| TypeHintHelper::isTypeDefinedInAnnotation($phpcsFile, $docCommentOpenPointer, $typeHint)
) {
continue;
}
$fullyQualifiedTypeHint = TypeHintHelper::getFullyQualifiedTypeHint(
$phpcsFile,
$annotation->getStartPointer(),
$typeHint
);
if ($fullyQualifiedTypeHint === $typeHint) {
continue;
}
$fix = $phpcsFile->addFixableError(sprintf(
'Class name %s in %s should be referenced via a fully qualified name.',
$fullyQualifiedTypeHint,
$annotationName
), $annotation->getStartPointer(), self::CODE_NON_FULLY_QUALIFIED_CLASS_NAME);
if (!$fix) {
continue;
}
$fixedAnnotationContent = AnnotationHelper::fixAnnotationType(
$phpcsFile,
$annotation,
$typeHintNode,
new IdentifierTypeNode($fullyQualifiedTypeHint)
);
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->replaceToken($annotation->getStartPointer(), $fixedAnnotationContent);
FixerHelper::removeBetweenIncluding($phpcsFile, $annotation->getStartPointer() + 1, $annotation->getEndPointer());
$phpcsFile->fixer->endChangeset();
}
}
foreach (AnnotationHelper::getAnnotationConstantExpressions($annotation) as $constantExpression) {
foreach (AnnotationConstantExpressionHelper::getConstantFetchNodes($constantExpression) as $constantFetchNode) {
$isClassConstant = $constantFetchNode->className !== '';
$typeHint = $isClassConstant
? $constantFetchNode->className
: $constantFetchNode->name;
if ($typeHint === 'self') {
continue;
}
$fullyQualifiedTypeHint = $isClassConstant
? NamespaceHelper::resolveClassName(
$phpcsFile,
$typeHint,
$annotation->getStartPointer()
) : NamespaceHelper::resolveName(
$phpcsFile,
$typeHint,
ReferencedName::TYPE_CONSTANT,
$annotation->getStartPointer()
);
if ($fullyQualifiedTypeHint === $typeHint) {
continue;
}
$fix = $phpcsFile->addFixableError(sprintf(
'%s name %s in %s should be referenced via a fully qualified name.',
$isClassConstant ? 'Class' : 'Constant',
$fullyQualifiedTypeHint,
$annotationName
), $annotation->getStartPointer(), self::CODE_NON_FULLY_QUALIFIED_CLASS_NAME);
if (!$fix) {
continue;
}
$fixedConstantFetchNode = $isClassConstant
? new ConstFetchNode($fullyQualifiedTypeHint, $constantFetchNode->name)
: new ConstFetchNode('', $fullyQualifiedTypeHint);
$fixedAnnotationContent = AnnotationHelper::fixAnnotationConstantFetchNode(
$phpcsFile,
$annotation,
$constantFetchNode,
$fixedConstantFetchNode
);
$phpcsFile->fixer->beginChangeset();
$phpcsFile->fixer->replaceToken($annotation->getStartPointer(), $fixedAnnotationContent);
FixerHelper::removeBetweenIncluding($phpcsFile, $annotation->getStartPointer() + 1, $annotation->getEndPointer());
$phpcsFile->fixer->endChangeset();
}
}
}
}
}
}