Make attributes of Request Api configurable (#51)

Co-authored-by: Sascha Egerer <[email protected]>

Author: tlueder

README.md

@@ -27,7 +27,7 @@ includes:
 
 ### Custom Context API Aspects
 
-If you use custom aspects for the TYPO3 Context API you can now add a mapping so PHPStan knows
+If you use custom aspects for the TYPO3 Context API you can add a mapping so PHPStan knows
 what type of aspect class is returned by the context API
 
 ```
@@ -36,3 +36,25 @@ parameters:
         contextApiGetAspectMapping:
             myCustomAspect: FlowdGmbh\MyProject\Context\MyCustomAspect
 ```
+
+```
+// PHPStan will now know that $myCustomAspect is of type FlowdGmbh\MyProject\Context\MyCustomAspect
+$myCustomAspect = GeneralUtility::makeInstance(Context::class)->getAspect('myCustomAspect');
+```
+
+### Custom Request Attribute
+
+If you use custom PSR-7 request attribute you can add a mapping so PHPStan knows
+what type of class is returned by Request::getAttribute()
+
+```
+parameters:
+    typo3:
+        requestApiGetAttributeMapping:
+            myAttribute: FlowdGmbh\MyProject\Http\MyAttribute
+```
+
+```
+// PHPStan will now know that $myAttribute is of type FlowdGmbh\MyProject\Http\MyAttribute
+$myAttribute = $request->getAttribute('myAttribute');
+```

extension.neon

@@ -47,6 +47,12 @@ services:
         class: SaschaEgerer\PhpstanTypo3\Type\RepositoryFindAllDynamicReturnTypeExtension
         tags:
             - phpstan.broker.dynamicMethodReturnTypeExtension
+    -
+        class: SaschaEgerer\PhpstanTypo3\Type\RequestDynamicReturnTypeExtension
+        arguments:
+            requestApiGetAttributeMapping: %typo3.requestApiGetAttributeMapping%
+        tags:
+            - phpstan.broker.dynamicMethodReturnTypeExtension
 parameters:
     bootstrapFiles:
         - phpstan.bootstrap.php
@@ -59,6 +65,14 @@ parameters:
             workspace: TYPO3\CMS\Core\Context\WorkspaceAspect
             language: TYPO3\CMS\Core\Context\LanguageAspect
             typoscript: TYPO3\CMS\Core\Context\TypoScriptAspect
+        requestApiGetAttributeMapping:
+            backend.user: TYPO3\CMS\Backend\FrontendBackendUserAuthentication
+            frontend.user: TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication
+            language: TYPO3\CMS\Core\Site\Entity\SiteLanguage
+            module: TYPO3\CMS\Backend\Module\ModuleInterface
+            moduleData: TYPO3\CMS\Backend\Module\ModuleData
+            normalizedParams: TYPO3\CMS\Core\Http\NormalizedParams
+            site: TYPO3\CMS\Core\Site\Entity\Site
     stubFiles:
         - stubs/DomainObjectInterface.stub
         - stubs/GeneralUtility.stub
@@ -112,4 +126,5 @@ parameters:
 parametersSchema:
     typo3: structure([
         contextApiGetAspectMapping: arrayOf(string())
+        requestApiGetAttributeMapping: arrayOf(string())
     ])

src/Type/RequestDynamicReturnTypeExtension.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Type;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\ObjectType;
+use PHPStan\Type\Type;
+
+class RequestDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	/** @var array<string, string> */
+	private $requestApiGetAttributeMapping;
+
+	/**
+	 * @param array<string, string> $requestApiGetAttributeMapping
+	 */
+	public function __construct(array $requestApiGetAttributeMapping)
+	{
+		$this->requestApiGetAttributeMapping = $requestApiGetAttributeMapping;
+	}
+
+	public function getClass(): string
+	{
+		return \Psr\Http\Message\ServerRequestInterface::class;
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): Type
+	{
+		$argument = $methodCall->getArgs()[0] ?? null;
+
+		if ($argument === null || !($argument->value instanceof \PhpParser\Node\Scalar\String_)) {
+			return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+		}
+
+		if (isset($this->requestApiGetAttributeMapping[$argument->value->value])) {
+			return new ObjectType($this->requestApiGetAttributeMapping[$argument->value->value]);
+		}
+
+		return ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+	}
+
+	public function isMethodSupported(
+		MethodReflection $methodReflection
+	): bool
+	{
+		return $methodReflection->getName() === 'getAttribute';
+	}
+
+}