Added validation rule for site attribute

Author: tlueder

extension.neon

@@ -45,6 +45,12 @@ services:
             requestGetAttributeMapping: %typo3.requestGetAttributeMapping%
         tags:
             - phpstan.rules.rule
+    -
+        class: SaschaEgerer\PhpstanTypo3\Rule\SiteAttributeValidationRule
+        arguments:
+            siteGetAttributeMapping: %typo3.siteGetAttributeMapping%
+        tags:
+            - phpstan.rules.rule
     -
         class: SaschaEgerer\PhpstanTypo3\Type\RepositoryQueryDynamicReturnTypeExtension
         tags:

src/Rule/SiteAttributeValidationRule.php

@@ -0,0 +1,69 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Rule;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\RuleErrorBuilder;
+use TYPO3\CMS\Core\Site\Entity\Site;
+
+/**
+ * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Expr\MethodCall>
+ */
+class SiteAttributeValidationRule implements \PHPStan\Rules\Rule
+{
+
+	/** @var array<string, string> */
+	private $siteGetAttributeMapping;
+
+	/**
+	 * @param array<string, string> $siteGetAttributeMapping
+	 */
+	public function __construct(array $siteGetAttributeMapping)
+	{
+		$this->siteGetAttributeMapping = $siteGetAttributeMapping;
+	}
+
+	public function getNodeType(): string
+	{
+		return Node\Expr\MethodCall::class;
+	}
+
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if (!$node->name instanceof Node\Identifier) {
+			return [];
+		}
+
+		$methodReflection = $scope->getMethodReflection($scope->getType($node->var), $node->name->toString());
+		if ($methodReflection === null || $methodReflection->getName() !== 'getAttribute') {
+			return [];
+		}
+
+		$declaringClass = $methodReflection->getDeclaringClass();
+
+		if (!$declaringClass->implementsInterface(Site::class) && $declaringClass->getName() !== Site::class) {
+			return [];
+		}
+
+		$argument = $node->getArgs()[0] ?? null;
+
+		if (!($argument instanceof Node\Arg) || !($argument->value instanceof Node\Scalar\String_)) {
+			return [];
+		}
+
+		if (isset($this->siteGetAttributeMapping[$argument->value->value])) {
+			return [];
+		}
+
+		$ruleError = RuleErrorBuilder::message(sprintf(
+			'There is no site attribute "%s" configured so we can\'t figure out the exact type to return when calling %s::%s',
+			$argument->value->value,
+			$declaringClass->getDisplayName(),
+			$methodReflection->getName()
+		))->tip('You should add custom site attribute to the typo3.siteGetAttributeMapping setting.')->build();
+
+		return [$ruleError];
+	}
+
+}