RestrictedPropertyUsageRule.php

<?php declare(strict_types = 1);

namespace PHPStan\Rules\RestrictedUsage;

use PhpParser\Node;
use PhpParser\Node\Identifier;
use PHPStan\Analyser\Scope;
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\DependencyInjection\Container;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;

/**
 * @implements Rule<Node\Expr\PropertyFetch>
 */
#[AutowiredService]
final class RestrictedPropertyUsageRule implements Rule
{

	/** @var RestrictedPropertyUsageExtension[] $extensions */
	private ?array $extensions = null;

	public function __construct(
		private Container $container,
		private ReflectionProvider $reflectionProvider,
	)
	{
	}

	public function getNodeType(): string
	{
		return Node\Expr\PropertyFetch::class;
	}

	/**
	 * @api
	 */
	public function processNode(Node $node, Scope $scope): array
	{
		if (!$node->name instanceof Identifier) {
			return [];
		}

		/** @var RestrictedPropertyUsageExtension[] $extensions */
		$extensions = $this->extensions ??= $this->container->getServicesByTag(RestrictedPropertyUsageExtension::PROPERTY_EXTENSION_TAG);
		if ($extensions === []) {
			return [];
		}

		$propertyName = $node->name->name;
		$propertyCalledOnType = $scope->getType($node->var);
		$referencedClasses = $propertyCalledOnType->getObjectClassNames();

		$errors = [];

		foreach ($referencedClasses as $referencedClass) {
			if (!$this->reflectionProvider->hasClass($referencedClass)) {
				continue;
			}

			$classReflection = $this->reflectionProvider->getClass($referencedClass);
			if (!$classReflection->hasInstanceProperty($propertyName)) {
				continue;
			}

			$propertyReflection = $classReflection->getInstanceProperty($propertyName, $scope);
			foreach ($extensions as $extension) {
				$restrictedUsage = $extension->isRestrictedPropertyUsage($propertyReflection, $scope);
				if ($restrictedUsage === null) {
					continue;
				}

				$errors[] = RuleErrorBuilder::message($restrictedUsage->errorMessage)
					->identifier($restrictedUsage->identifier)
					->build();
			}
		}

		return $errors;
	}

}