Fix invalid interface implementation by dynamic return type

The object storage offsetGet() is not compatible with the
ArrayAccess interface but does some TYPO3 sepcific stuff.
We can't set the correct return type via a stub as phpstan
will complain that the return type is not compatible with
the interface.
To work around this we have to implement a dynamic return
type extension again.

Author: sascha-egerer

extension.neon

@@ -8,6 +8,10 @@ services:
         class: SaschaEgerer\PhpstanTypo3\Type\ValidatorResolverDynamicReturnTypeExtension
         tags:
             - phpstan.broker.dynamicMethodReturnTypeExtension
+    -
+        class: SaschaEgerer\PhpstanTypo3\Type\ObjectStorageDynamicReturnTypeExtension
+        tags:
+            - phpstan.broker.dynamicMethodReturnTypeExtension
     -
         class: SaschaEgerer\PhpstanTypo3\Type\ContextDynamicReturnTypeExtension
         arguments:

src/Type/ObjectStorageDynamicReturnTypeExtension.php

@@ -0,0 +1,54 @@
+<?php declare(strict_types = 1);
+
+namespace SaschaEgerer\PhpstanTypo3\Type;
+
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Type\DynamicMethodReturnTypeExtension;
+use PHPStan\Type\IntegerType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
+
+class ObjectStorageDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
+{
+
+	public function getClass(): string
+	{
+		return ObjectStorage::class;
+	}
+
+	public function isMethodSupported(
+		MethodReflection $methodReflection
+	): bool
+	{
+		return $methodReflection->getName() === 'offsetGet';
+	}
+
+	public function getTypeFromMethodCall(
+		MethodReflection $methodReflection,
+		MethodCall $methodCall,
+		Scope $scope
+	): ?Type
+	{
+		$firstArgument = $methodCall->args[0] ?? null;
+
+		if (!$firstArgument instanceof Arg) {
+			return null;
+		}
+
+		$argumentType = $scope->getType($firstArgument->value);
+
+		if ((new StringType())->isSuperTypeOf($argumentType)->yes()) {
+			return null;
+		}
+		if ((new IntegerType())->isSuperTypeOf($argumentType)->yes()) {
+			return null;
+		}
+		return new MixedType();
+	}
+
+}

stubs/ObjectStorage.stub

@@ -2,7 +2,7 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template TEntity
+ * @template TEntity of object
  * @implements \ArrayAccess<string, TEntity>
  * @implements \Iterator<string, TEntity>
  * @phpstan-type ObjectStorageInternal array{obj: TEntity, inf: mixed}
@@ -31,12 +31,6 @@ class ObjectStorage implements \Iterator, \ArrayAccess
      */
     public function offsetUnset($value);
 
-    /**
-     * @param TEntity|int|string $value
-     * @return ($value is int ? TEntity|null : mixed)
-     */
-    public function offsetGet($value);
-
     /**
      * This is different from the SplObjectStorage as the key in this implementation is the object hash (string).
      * @phpstan-ignore-next-line See https://forge.typo3.org/issues/98146

stubs/QueryResultInterface.stub

@@ -2,7 +2,7 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template TKey
+ * @template TKey of int
  * @template TValue of object
  * @extends \Iterator<TKey, TValue>
  * @extends \ArrayAccess<TKey, TValue>

tests/Unit/Type/QueryResultToArrayDynamicReturnTypeExtension/data/query-result-to-array.php

@@ -135,6 +135,12 @@ public function showAction(): void
 			'list<SaschaEgerer\PhpstanTypo3\Tests\Unit\Type\QueryResultToArrayDynamicReturnTypeExtension\FrontendUserGroup>',
 			$myObjects
 		);
+
+		$key = $queryResult->key();
+		assertType(
+			'int',
+			$key
+		);
 	}
 
 }

tests/Unit/Type/data/object-storage-stub-files.php

@@ -29,6 +29,7 @@ public function foo(): void
 		}
 
 		assertType(self::class . '|null', $objectStorage->offsetGet(0));
+		assertType(self::class . '|null', $objectStorage->current());
 
 		// We ignore errors in the next line as this will produce an
 		// "Offset 0 does not exist on TYPO3\CMS\Extbase\Persistence\ObjectStorage<ObjectStorage\My\Test\Extension\Domain\Model\MyModel>