-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
RequireAttributeNamespaceRule.php
79 lines (68 loc) · 1.81 KB
/
RequireAttributeNamespaceRule.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
<?php
declare(strict_types=1);
namespace Symplify\PHPStanRules\Rules\Domain;
use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Node\InClassNode;
use PHPStan\Rules\Rule;
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Symplify\PHPStanRules\Tests\Rules\Domain\RequireAttributeNamespaceRule\RequireAttributeNamespaceRuleTest
*/
final class RequireAttributeNamespaceRule implements Rule, DocumentedRuleInterface
{
/**
* @var string
*/
public const ERROR_MESSAGE = 'Attribute must be located in "Attribute" namespace';
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(self::ERROR_MESSAGE, [
new CodeSample(
<<<'CODE_SAMPLE'
// app/Entity/SomeAttribute.php
namespace App\Controller;
#[\Attribute]
final class SomeAttribute
{
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
// app/Attribute/SomeAttribute.php
namespace App\Attribute;
#[\Attribute]
final class SomeAttribute
{
}
CODE_SAMPLE
),
]);
}
/**
* @return class-string<Node>
*/
public function getNodeType(): string
{
return InClassNode::class;
}
/**
* @param InClassNode $node
* @return string[]
*/
public function processNode(Node $node, Scope $scope): array
{
$classReflection = $node->getClassReflection();
if (! $classReflection->isAttributeClass()) {
return [];
}
// is class in "Attribute" namespace?
$className = $classReflection->getName();
if (str_contains($className, '\\Attribute\\')) {
return [];
}
return [self::ERROR_MESSAGE];
}
}