Skip to content

Commit 777a82a

Browse files
ondrejmirtesondrejmirtes
committed
Do not report static in PHPDoc tags above traits as an error
1 parent 9c4bee9 commit 777a82a

30 files changed

+898
-159
lines changed

‎conf/config.level0.neon

+5
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ conditionalTags:
3232
phpstan.rules.rule: %featureToggles.validatePregQuote%
3333
PHPStan\Rules\Keywords\RequireFileExistsRule:
3434
phpstan.rules.rule: %featureToggles.requireFileExists%
35+
PHPStan\Rules\Classes\LocalTypeTraitUseAliasesRule:
36+
phpstan.rules.rule: %featureToggles.absentTypeChecks%
3537

3638
rules:
3739
- PHPStan\Rules\Api\ApiInstantiationRule
@@ -148,6 +150,9 @@ services:
148150
arguments:
149151
checkClassCaseSensitivity: %checkClassCaseSensitivity%
150152

153+
-
154+
class: PHPStan\Rules\Classes\LocalTypeTraitUseAliasesRule
155+
151156
-
152157
class: PHPStan\Rules\Exceptions\CaughtExceptionExistenceRule
153158
tags:

‎conf/config.level2.neon

+10
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,14 @@ conditionalTags:
5353
phpstan.rules.rule: %featureToggles.absentTypeChecks%
5454
PHPStan\Rules\Classes\MethodTagTraitRule:
5555
phpstan.rules.rule: %featureToggles.absentTypeChecks%
56+
PHPStan\Rules\Classes\MethodTagTraitUseRule:
57+
phpstan.rules.rule: %featureToggles.absentTypeChecks%
5658
PHPStan\Rules\Classes\PropertyTagRule:
5759
phpstan.rules.rule: %featureToggles.absentTypeChecks%
5860
PHPStan\Rules\Classes\PropertyTagTraitRule:
5961
phpstan.rules.rule: %featureToggles.absentTypeChecks%
62+
PHPStan\Rules\Classes\PropertyTagTraitUseRule:
63+
phpstan.rules.rule: %featureToggles.absentTypeChecks%
6064
PHPStan\Rules\Functions\IncompatibleArrowFunctionDefaultParameterTypeRule:
6165
phpstan.rules.rule: %featureToggles.closureDefaultParameterTypeRule%
6266
PHPStan\Rules\Functions\IncompatibleClosureDefaultParameterTypeRule:
@@ -89,12 +93,18 @@ services:
8993
-
9094
class: PHPStan\Rules\Classes\MethodTagTraitRule
9195

96+
-
97+
class: PHPStan\Rules\Classes\MethodTagTraitUseRule
98+
9299
-
93100
class: PHPStan\Rules\Classes\PropertyTagRule
94101

95102
-
96103
class: PHPStan\Rules\Classes\PropertyTagTraitRule
97104

105+
-
106+
class: PHPStan\Rules\Classes\PropertyTagTraitUseRule
107+
98108
-
99109
class: PHPStan\Rules\PhpDoc\RequireExtendsCheck
100110
arguments:

‎src/Analyser/NodeScopeResolver.php

+4-1
Original file line numberDiff line numberDiff line change
@@ -5788,8 +5788,11 @@ private function processNodesForTraitUse($node, ClassReflection $traitReflection
57885788
$methodAst->name = $methodNames[$methodName];
57895789
}
57905790

5791+
if (!$scope->isInClass()) {
5792+
throw new ShouldNotHappenException();
5793+
}
57915794
$traitScope = $scope->enterTrait($traitReflection);
5792-
$nodeCallback(new InTraitNode($node, $traitReflection), $traitScope);
5795+
$nodeCallback(new InTraitNode($node, $traitReflection, $scope->getClassReflection()), $traitScope);
57935796
$this->processStmtNodes($node, $stmts, $traitScope, $nodeCallback, StatementContext::createTopLevel());
57945797
return;
57955798
}

‎src/Node/InTraitNode.php

+6-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
class InTraitNode extends Node\Stmt implements VirtualNode
1313
{
1414

15-
public function __construct(private Node\Stmt\Trait_ $originalNode, private ClassReflection $traitReflection)
15+
public function __construct(private Node\Stmt\Trait_ $originalNode, private ClassReflection $traitReflection, private ClassReflection $implementingClassReflection)
1616
{
1717
parent::__construct($originalNode->getAttributes());
1818
}
@@ -27,6 +27,11 @@ public function getTraitReflection(): ClassReflection
2727
return $this->traitReflection;
2828
}
2929

30+
public function getImplementingClassReflection(): ClassReflection
31+
{
32+
return $this->implementingClassReflection;
33+
}
34+
3035
public function getType(): string
3136
{
3237
return 'PHPStan_Stmt_InTraitNode';

‎src/PhpDoc/StubValidator.php

+6
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@
2626
use PHPStan\Rules\Classes\LocalTypeAliasesCheck;
2727
use PHPStan\Rules\Classes\LocalTypeAliasesRule;
2828
use PHPStan\Rules\Classes\LocalTypeTraitAliasesRule;
29+
use PHPStan\Rules\Classes\LocalTypeTraitUseAliasesRule;
2930
use PHPStan\Rules\Classes\MethodTagCheck;
3031
use PHPStan\Rules\Classes\MethodTagRule;
3132
use PHPStan\Rules\Classes\MethodTagTraitRule;
33+
use PHPStan\Rules\Classes\MethodTagTraitUseRule;
3234
use PHPStan\Rules\Classes\MixinRule;
3335
use PHPStan\Rules\Classes\PropertyTagCheck;
3436
use PHPStan\Rules\Classes\PropertyTagRule;
3537
use PHPStan\Rules\Classes\PropertyTagTraitRule;
38+
use PHPStan\Rules\Classes\PropertyTagTraitUseRule;
3639
use PHPStan\Rules\ClassNameCheck;
3740
use PHPStan\Rules\DirectRegistry as DirectRuleRegistry;
3841
use PHPStan\Rules\FunctionDefinitionCheck;
@@ -242,11 +245,14 @@ private function getRuleRegistry(Container $container): RuleRegistry
242245
$methodTagCheck = new MethodTagCheck($reflectionProvider, $classNameCheck, $genericObjectTypeCheck, $missingTypehintCheck, $unresolvableTypeHelper, true);
243246
$rules[] = new MethodTagRule($methodTagCheck);
244247
$rules[] = new MethodTagTraitRule($methodTagCheck, $reflectionProvider);
248+
$rules[] = new MethodTagTraitUseRule($methodTagCheck);
245249

246250
$propertyTagCheck = new PropertyTagCheck($reflectionProvider, $classNameCheck, $genericObjectTypeCheck, $missingTypehintCheck, $unresolvableTypeHelper, true);
247251
$rules[] = new PropertyTagRule($propertyTagCheck);
248252
$rules[] = new PropertyTagTraitRule($propertyTagCheck, $reflectionProvider);
253+
$rules[] = new PropertyTagTraitUseRule($propertyTagCheck);
249254
$rules[] = new MixinRule($reflectionProvider, $classNameCheck, $genericObjectTypeCheck, $missingTypehintCheck, $unresolvableTypeHelper, true, true);
255+
$rules[] = new LocalTypeTraitUseAliasesRule($localTypeAliasesCheck);
250256
}
251257

252258
return new DirectRuleRegistry($rules);

‎src/Reflection/ClassReflection.php

+27
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ class ClassReflection
129129

130130
private false|ResolvedPhpDocBlock $resolvedPhpDocBlock = false;
131131

132+
private false|ResolvedPhpDocBlock $traitContextResolvedPhpDocBlock = false;
133+
132134
/** @var ClassReflection[]|null */
133135
private ?array $cachedInterfaces = null;
134136

@@ -1580,6 +1582,31 @@ public function getResolvedPhpDoc(): ?ResolvedPhpDocBlock
15801582
return $this->resolvedPhpDocBlock = $this->fileTypeMapper->getResolvedPhpDoc($fileName, $this->getName(), null, null, $this->reflectionDocComment);
15811583
}
15821584

1585+
public function getTraitContextResolvedPhpDoc(self $implementingClass): ?ResolvedPhpDocBlock
1586+
{
1587+
if (!$this->isTrait()) {
1588+
throw new ShouldNotHappenException();
1589+
}
1590+
if (!$implementingClass->isClass()) {
1591+
throw new ShouldNotHappenException();
1592+
}
1593+
$fileName = $this->getFileName();
1594+
if (is_bool($this->reflectionDocComment)) {
1595+
$docComment = $this->reflection->getDocComment();
1596+
$this->reflectionDocComment = $docComment !== false ? $docComment : null;
1597+
}
1598+
1599+
if ($this->reflectionDocComment === null) {
1600+
return null;
1601+
}
1602+
1603+
if ($this->traitContextResolvedPhpDocBlock !== false) {
1604+
return $this->traitContextResolvedPhpDocBlock;
1605+
}
1606+
1607+
return $this->traitContextResolvedPhpDocBlock = $this->fileTypeMapper->getResolvedPhpDoc($fileName, $implementingClass->getName(), $this->getName(), null, $this->reflectionDocComment);
1608+
}
1609+
15831610
private function getFirstExtendsTag(): ?ExtendsTag
15841611
{
15851612
foreach ($this->getExtendsTags() as $tag) {

‎src/Rules/Classes/LocalTypeAliasesCheck.php

+120-62
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,22 @@ public function __construct(
5353
* @return list<IdentifierRuleError>
5454
*/
5555
public function check(ClassReflection $reflection, ClassLike $node): array
56+
{
57+
$errors = [];
58+
foreach ($this->checkInTraitDefinitionContext($reflection) as $error) {
59+
$errors[] = $error;
60+
}
61+
foreach ($this->checkInTraitUseContext($reflection, $reflection, $node) as $error) {
62+
$errors[] = $error;
63+
}
64+
65+
return $errors;
66+
}
67+
68+
/**
69+
* @return list<IdentifierRuleError>
70+
*/
71+
public function checkInTraitDefinitionContext(ClassReflection $reflection): array
5672
{
5773
$phpDoc = $reflection->getResolvedPhpDoc();
5874
if ($phpDoc === null) {
@@ -69,7 +85,7 @@ public function check(ClassReflection $reflection, ClassLike $node): array
6985
};
7086

7187
$errors = [];
72-
$className = $reflection->getName();
88+
$className = $reflection->getDisplayName();
7389

7490
$importedAliases = [];
7591

@@ -162,78 +178,86 @@ public function check(ClassReflection $reflection, ClassLike $node): array
162178
}
163179

164180
$resolvedType = $typeAliasTag->getTypeAlias()->resolve($this->typeNodeResolver);
165-
$foundError = false;
166-
TypeTraverser::map($resolvedType, static function (Type $type, callable $traverse) use (&$errors, &$foundError, $aliasName): Type {
167-
if ($foundError) {
168-
return $type;
169-
}
170-
171-
if ($type instanceof CircularTypeAliasErrorType) {
172-
$errors[] = RuleErrorBuilder::message(sprintf('Circular definition detected in type alias %s.', $aliasName))
173-
->identifier('typeAlias.circular')
174-
->build();
175-
$foundError = true;
176-
return $type;
177-
}
178-
179-
if ($type instanceof ErrorType) {
180-
$errors[] = RuleErrorBuilder::message(sprintf('Invalid type definition detected in type alias %s.', $aliasName))
181-
->identifier('typeAlias.invalidType')
182-
->build();
183-
$foundError = true;
184-
return $type;
185-
}
186-
187-
return $traverse($type);
188-
});
189-
190-
if ($foundError) {
181+
if ($this->hasErrorType($resolvedType, $aliasName, $errors)) {
191182
continue;
192183
}
193184

194185
if (!$this->absentTypeChecks) {
195186
continue;
196187
}
197188

198-
if ($this->checkMissingTypehints) {
199-
foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($resolvedType) as $iterableType) {
200-
$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
201-
$errors[] = RuleErrorBuilder::message(sprintf(
202-
'%s %s has type alias %s with no value type specified in iterable type %s.',
203-
$reflection->getClassTypeDescription(),
204-
$reflection->getDisplayName(),
205-
$aliasName,
206-
$iterableTypeDescription,
207-
))
208-
->tip(MissingTypehintCheck::MISSING_ITERABLE_VALUE_TYPE_TIP)
209-
->identifier('missingType.iterableValue')
210-
->build();
211-
}
189+
if (!$this->checkMissingTypehints) {
190+
continue;
191+
}
212192

213-
foreach ($this->missingTypehintCheck->getNonGenericObjectTypesWithGenericClass($resolvedType) as [$name, $genericTypeNames]) {
214-
$errors[] = RuleErrorBuilder::message(sprintf(
215-
'%s %s has type alias %s with generic %s but does not specify its types: %s',
216-
$reflection->getClassTypeDescription(),
217-
$reflection->getDisplayName(),
218-
$aliasName,
219-
$name,
220-
implode(', ', $genericTypeNames),
221-
))
222-
->identifier('missingType.generics')
223-
->build();
224-
}
193+
foreach ($this->missingTypehintCheck->getIterableTypesWithMissingValueTypehint($resolvedType) as $iterableType) {
194+
$iterableTypeDescription = $iterableType->describe(VerbosityLevel::typeOnly());
195+
$errors[] = RuleErrorBuilder::message(sprintf(
196+
'%s %s has type alias %s with no value type specified in iterable type %s.',
197+
$reflection->getClassTypeDescription(),
198+
$reflection->getDisplayName(),
199+
$aliasName,
200+
$iterableTypeDescription,
201+
))
202+
->tip(MissingTypehintCheck::MISSING_ITERABLE_VALUE_TYPE_TIP)
203+
->identifier('missingType.iterableValue')
204+
->build();
205+
}
225206

226-
foreach ($this->missingTypehintCheck->getCallablesWithMissingSignature($resolvedType) as $callableType) {
227-
$errors[] = RuleErrorBuilder::message(sprintf(
228-
'%s %s has type alias %s with no signature specified for %s.',
229-
$reflection->getClassTypeDescription(),
230-
$reflection->getDisplayName(),
231-
$aliasName,
232-
$callableType->describe(VerbosityLevel::typeOnly()),
233-
))->identifier('missingType.callable')->build();
234-
}
207+
foreach ($this->missingTypehintCheck->getNonGenericObjectTypesWithGenericClass($resolvedType) as [$name, $genericTypeNames]) {
208+
$errors[] = RuleErrorBuilder::message(sprintf(
209+
'%s %s has type alias %s with generic %s but does not specify its types: %s',
210+
$reflection->getClassTypeDescription(),
211+
$reflection->getDisplayName(),
212+
$aliasName,
213+
$name,
214+
implode(', ', $genericTypeNames),
215+
))
216+
->identifier('missingType.generics')
217+
->build();
218+
}
219+
220+
foreach ($this->missingTypehintCheck->getCallablesWithMissingSignature($resolvedType) as $callableType) {
221+
$errors[] = RuleErrorBuilder::message(sprintf(
222+
'%s %s has type alias %s with no signature specified for %s.',
223+
$reflection->getClassTypeDescription(),
224+
$reflection->getDisplayName(),
225+
$aliasName,
226+
$callableType->describe(VerbosityLevel::typeOnly()),
227+
))->identifier('missingType.callable')->build();
235228
}
229+
}
236230

231+
return $errors;
232+
}
233+
234+
/**
235+
* @return list<IdentifierRuleError>
236+
*/
237+
public function checkInTraitUseContext(
238+
ClassReflection $reflection,
239+
ClassReflection $implementingClassReflection,
240+
ClassLike $node,
241+
): array
242+
{
243+
if ($reflection->getNativeReflection()->getName() === $implementingClassReflection->getName()) {
244+
$phpDoc = $reflection->getResolvedPhpDoc();
245+
} else {
246+
$phpDoc = $reflection->getTraitContextResolvedPhpDoc($implementingClassReflection);
247+
}
248+
if ($phpDoc === null) {
249+
return [];
250+
}
251+
252+
$errors = [];
253+
254+
foreach ($phpDoc->getTypeAliasTags() as $typeAliasTag) {
255+
$aliasName = $typeAliasTag->getAliasName();
256+
$resolvedType = $typeAliasTag->getTypeAlias()->resolve($this->typeNodeResolver);
257+
$throwawayErrors = [];
258+
if ($this->hasErrorType($resolvedType, $aliasName, $throwawayErrors)) {
259+
continue;
260+
}
237261
foreach ($resolvedType->getReferencedClasses() as $class) {
238262
if (!$this->reflectionProvider->hasClass($class)) {
239263
$errors[] = RuleErrorBuilder::message(sprintf('Type alias %s contains unknown class %s.', $aliasName, $class))
@@ -304,4 +328,38 @@ private function isAliasNameValid(string $aliasName, ?NameScope $nameScope): boo
304328
|| $aliasNameResolvedType instanceof TemplateType; // aliases take precedence over type parameters, this is reported by other rules using TemplateTypeCheck
305329
}
306330

331+
/**
332+
* @param list<IdentifierRuleError> $errors
333+
* @param-out list<IdentifierRuleError> $errors
334+
*/
335+
private function hasErrorType(Type $type, string $aliasName, array &$errors): bool
336+
{
337+
$foundError = false;
338+
TypeTraverser::map($type, static function (Type $type, callable $traverse) use (&$errors, &$foundError, $aliasName): Type {
339+
if ($foundError) {
340+
return $type;
341+
}
342+
343+
if ($type instanceof CircularTypeAliasErrorType) {
344+
$errors[] = RuleErrorBuilder::message(sprintf('Circular definition detected in type alias %s.', $aliasName))
345+
->identifier('typeAlias.circular')
346+
->build();
347+
$foundError = true;
348+
return $type;
349+
}
350+
351+
if ($type instanceof ErrorType) {
352+
$errors[] = RuleErrorBuilder::message(sprintf('Invalid type definition detected in type alias %s.', $aliasName))
353+
->identifier('typeAlias.invalidType')
354+
->build();
355+
$foundError = true;
356+
return $type;
357+
}
358+
359+
return $traverse($type);
360+
});
361+
362+
return $foundError;
363+
}
364+
307365
}

‎src/Rules/Classes/LocalTypeTraitAliasesRule.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function processNode(Node $node, Scope $scope): array
3333
return [];
3434
}
3535

36-
return $this->check->check($this->reflectionProvider->getClass($traitName->toString()), $node);
36+
return $this->check->checkInTraitDefinitionContext($this->reflectionProvider->getClass($traitName->toString()));
3737
}
3838

3939
}

0 commit comments

Comments
 (0)