| 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\AutowiredService; |
| 9: | use PHPStan\DependencyInjection\Container; |
| 10: | use PHPStan\Reflection\ReflectionProvider; |
| 11: | use PHPStan\Rules\Rule; |
| 12: | use PHPStan\Rules\RuleErrorBuilder; |
| 13: | |
| 14: | |
| 15: | |
| 16: | |
| 17: | #[AutowiredService] |
| 18: | final class RestrictedPropertyUsageRule implements Rule |
| 19: | { |
| 20: | |
| 21: | |
| 22: | private ?array $extensions = null; |
| 23: | |
| 24: | public function __construct( |
| 25: | private Container $container, |
| 26: | private ReflectionProvider $reflectionProvider, |
| 27: | ) |
| 28: | { |
| 29: | } |
| 30: | |
| 31: | public function getNodeType(): string |
| 32: | { |
| 33: | return Node\Expr\PropertyFetch::class; |
| 34: | } |
| 35: | |
| 36: | |
| 37: | |
| 38: | |
| 39: | public function processNode(Node $node, Scope $scope): array |
| 40: | { |
| 41: | if (!$node->name instanceof Identifier) { |
| 42: | return []; |
| 43: | } |
| 44: | |
| 45: | |
| 46: | $extensions = $this->extensions ??= $this->container->getServicesByTag(RestrictedPropertyUsageExtension::PROPERTY_EXTENSION_TAG); |
| 47: | if ($extensions === []) { |
| 48: | return []; |
| 49: | } |
| 50: | |
| 51: | $propertyName = $node->name->name; |
| 52: | $propertyCalledOnType = $scope->getType($node->var); |
| 53: | $referencedClasses = $propertyCalledOnType->getObjectClassNames(); |
| 54: | |
| 55: | $errors = []; |
| 56: | |
| 57: | foreach ($referencedClasses as $referencedClass) { |
| 58: | if (!$this->reflectionProvider->hasClass($referencedClass)) { |
| 59: | continue; |
| 60: | } |
| 61: | |
| 62: | $classReflection = $this->reflectionProvider->getClass($referencedClass); |
| 63: | if (!$classReflection->hasInstanceProperty($propertyName)) { |
| 64: | continue; |
| 65: | } |
| 66: | |
| 67: | $propertyReflection = $classReflection->getInstanceProperty($propertyName, $scope); |
| 68: | foreach ($extensions as $extension) { |
| 69: | $restrictedUsage = $extension->isRestrictedPropertyUsage($propertyReflection, $scope); |
| 70: | if ($restrictedUsage === null) { |
| 71: | continue; |
| 72: | } |
| 73: | |
| 74: | $errors[] = RuleErrorBuilder::message($restrictedUsage->errorMessage) |
| 75: | ->identifier($restrictedUsage->identifier) |
| 76: | ->build(); |
| 77: | } |
| 78: | } |
| 79: | |
| 80: | return $errors; |
| 81: | } |
| 82: | |
| 83: | } |
| 84: | |