1: <?php declare(strict_types = 1);
2:
3: namespace PHPStan\Rules\RestrictedUsage;
4:
5: use PhpParser\Node;
6: use PhpParser\Node\Identifier;
7: use PHPStan\Analyser\Scope;
8: use PHPStan\DependencyInjection\AutowiredExtensions;
9: use PHPStan\DependencyInjection\AutowiredService;
10: use PHPStan\DependencyInjection\ExtensionsCollection;
11: use PHPStan\Reflection\ReflectionProvider;
12: use PHPStan\Rules\Rule;
13: use PHPStan\Rules\RuleErrorBuilder;
14: use PHPStan\Type\ObjectWithoutClassType;
15: use PHPStan\Type\TypeCombinator;
16:
17: /**
18: * @implements Rule<Node\Expr\PropertyFetch>
19: */
20: #[AutowiredService]
21: final class RestrictedPropertyUsageRule implements Rule
22: {
23:
24: /**
25: * @param ExtensionsCollection<RestrictedPropertyUsageExtension> $extensions
26: */
27: public function __construct(
28: #[AutowiredExtensions(of: RestrictedPropertyUsageExtension::class)]
29: private ExtensionsCollection $extensions,
30: private ReflectionProvider $reflectionProvider,
31: )
32: {
33: }
34:
35: public function getNodeType(): string
36: {
37: return Node\Expr\PropertyFetch::class;
38: }
39:
40: /**
41: * @api
42: */
43: public function processNode(Node $node, Scope $scope): array
44: {
45: if (!$node->name instanceof Identifier) {
46: return [];
47: }
48:
49: $extensions = $this->extensions->getAll();
50: if ($extensions === []) {
51: return [];
52: }
53:
54: $propertyName = $node->name->name;
55: $propertyCalledOnType = $scope->getType($node->var);
56: // the intersection only removes what is not an object, such as the null of a nullable type
57: $objectType = $propertyCalledOnType->isObject()->yes() ? $propertyCalledOnType : TypeCombinator::intersect($propertyCalledOnType, new ObjectWithoutClassType());
58: $referencedClasses = $objectType->getObjectClassNames();
59:
60: $errors = [];
61:
62: foreach ($referencedClasses as $referencedClass) {
63: if (!$this->reflectionProvider->hasClass($referencedClass)) {
64: continue;
65: }
66:
67: $classReflection = $this->reflectionProvider->getClass($referencedClass);
68: if (!$classReflection->hasInstanceProperty($propertyName)) {
69: continue;
70: }
71:
72: $propertyReflection = $classReflection->getInstanceProperty($propertyName, $scope);
73: foreach ($extensions as $extension) {
74: $restrictedUsage = $extension->isRestrictedPropertyUsage($propertyReflection, $scope);
75: if ($restrictedUsage === null) {
76: continue;
77: }
78:
79: $errorBuilder = RuleErrorBuilder::message($restrictedUsage->errorMessage)
80: ->identifier($restrictedUsage->identifier);
81: if ($restrictedUsage->tip !== null) {
82: $errorBuilder->tip($restrictedUsage->tip);
83: }
84:
85: $errors[] = $errorBuilder->build();
86: }
87: }
88:
89: return $errors;
90: }
91:
92: }
93: