TASK: Load stubs depending on TYPO3 version

extension.neon

@@ -140,17 +140,9 @@ parameters:
             routeEnhancers: array
             websiteTitle: string
     stubFiles:
-        - stubs/DomainObjectInterface.stub
         - stubs/EventDispatcher.stub
         - stubs/ObjectStorage.stub
-        - stubs/QueryFactory.stub
-        - stubs/QueryInterface.stub
-        - stubs/QueryResultInterface.stub
-        - stubs/Repository.stub
-        # See SaschaEgerer\PhpstanTypo3\Stubs\StubFilesExtensionLoader
-        # GeneralUtility.stub is only used if TYPO3 version is < 12
-        #- stubs/GeneralUtility.stub
-        #- stubs/QueryResult.stub
+        # Some stubs are loaded depending on the TYPO3 version used. See SaschaEgerer\PhpstanTypo3\Stubs\StubFilesExtensionLoader
     dynamicConstantNames:
         - TYPO3_MODE
         - TYPO3_REQUESTTYPE

src/Stubs/StubFilesExtensionLoader.php

@@ -20,7 +20,12 @@ public function getFiles(): array
 			$files[] = $stubsDir . '/GeneralUtility.stub';
 		}
 		if ($versionParser->parseConstraints($typo3Version->getVersion())->matches($versionParser->parseConstraints('<= 12.2.0'))) {
-			$files[] = $stubsDir . '/QueryResult.stub';
+			$files[] = $stubsDir . '/QueryFactory.stub';
+			$files[] = $stubsDir . '/QueryFactory.stub';
+			$files[] = $stubsDir . '/Repository.stub';
+			$files[] = $stubsDir . '/DomainObjectInterface.stub';
+			$files[] = $stubsDir . '/QueryInterface.stub';
+			$files[] = $stubsDir . '/QueryResultInterface.stub';
 		}
 
 		return $files;

src/Type/QueryResultToArrayDynamicReturnTypeExtension.php

@@ -51,9 +51,10 @@ public function getTypeFromMethodCall(
 		if ($resultType instanceof GenericObjectType) {
 			$modelType = $resultType->getTypes()[0] ?? new ErrorType();
 		} else {
-			$modelType = $methodReflection->getDeclaringClass()
-				->getPossiblyIncompleteActiveTemplateTypeMap()
-				->getType('ModelType') ?? new ErrorType();
+			$declaringClass = $methodReflection->getDeclaringClass();
+			$possibleTypes = $declaringClass->getPossiblyIncompleteActiveTemplateTypeMap();
+			$type = $possibleTypes->getType('TValue');
+			$modelType = $type ?? new ErrorType();
 		}
 
 		return new ArrayType(new IntegerType(), $modelType);

stubs/QueryInterface.stub

@@ -2,27 +2,27 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template ModelType
+ * @template T of object
  */
 interface QueryInterface
 {
-    public const ORDER_ASCENDING = 'ASC';
-    public const ORDER_DESCENDING = 'DESC';
-
     /**
-     * @param bool $returnRawQueryResult
-     * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface<ModelType>|array<string, mixed>
+     * @param bool $returnRawQueryResult avoids the object mapping by the persistence
+     * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|object[] The query result object or an array if $returnRawQueryResult is TRUE
+     * @phpstan-return ($returnRawQueryResult is true ? list<T> : QueryResultInterface<int,T>)
      */
     public function execute($returnRawQueryResult = false);
 
     /**
      * @param mixed $constraint
-     * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface<ModelType>
+     * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
+     * @phpstan-return QueryInterface<T>
      */
     public function matching($constraint);
 
     /**
-     * @return class-string<ModelType>
+     * @return string
+     * @phpstan-return class-string<T>
      */
     public function getType();
 }

stubs/QueryResult.stub

@@ -4,13 +4,14 @@ namespace TYPO3\CMS\Extbase\Persistence\Generic;
 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
 /**
- * @template ModelType
- * @implements QueryResultInterface<ModelType>
+ * @template TValue of object
+ * @implements QueryResultInterface<mixed,TValue>
  */
 class QueryResult implements QueryResultInterface
 {
     /**
-     * @return null|ModelType
+     * @return object
+     * @phpstan-return TValue|null
      */
     public function getFirst();
 }

stubs/QueryResultInterface.stub

@@ -2,24 +2,29 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template ModelType
- * @extends \ArrayAccess<string, ModelType>
- * @extends \Iterator<string, ModelType>
+ * A lazy result list that is returned by Query::execute()
+ * @template TKey
+ * @template TValue of object
+ * @extends \Iterator<TKey,TValue>
+ * @extends \ArrayAccess<TKey,TValue>
  */
 interface QueryResultInterface extends \Countable, \Iterator, \ArrayAccess
 {
     /**
-     * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface<ModelType>
+     * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
+     * @phpstan-return QueryInterface<TValue>
      */
     public function getQuery();
 
     /**
-     * @return null|ModelType
+     * @return object|null
+     * @phpstan-return TValue|null
      */
     public function getFirst();
 
     /**
-     * @return ModelType[]
+     * @return array
+     * @phpstan-return list<TValue>
      */
     public function toArray();
 }

stubs/Repository.stub

@@ -2,47 +2,58 @@
 namespace TYPO3\CMS\Extbase\Persistence;
 
 /**
- * @template TEntityClass of \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface
+ * @template T of \TYPO3\CMS\Extbase\DomainObject\DomainObjectInterface
+ * @implements RepositoryInterface<T>
  */
 class Repository
 {
     /**
-     * @var class-string<TEntityClass>
+     * @var string
+     * @phpstan-var class-string<T>
      */
     protected $objectType;
 
     /**
-     * @phpstan-param TEntityClass $object
-     * @phpstan-return void
+     * @param object $object The object to add
+     * @phpstan-param T $object
+     * @throws Exception\IllegalObjectTypeException
+     * return void
      */
     public function add($object);
 
     /**
-     * @phpstan-param TEntityClass $object
-     * @phpstan-return void
+     * @param object $object The object to remove
+     * @phpstan-param T $object
+     * @throws Exception\IllegalObjectTypeException
+     * @return void
      */
     public function remove($object);
 
     /**
-     * @phpstan-param TEntityClass $modifiedObject
-     * @phpstan-return void
+     * @param object $modifiedObject The modified object
+     * @phpstan-param T $modifiedObject
+     * @throws Exception\UnknownObjectException
+     * @throws Exception\IllegalObjectTypeException
      */
     public function update($modifiedObject);
 
     /**
-     * @phpstan-return QueryResultInterface<TEntityClass>|list<TEntityClass>
+     * @return QueryResultInterface|array
+     * @phpstan-return QueryResultInterface|iterable<T>
      */
     public function findAll();
 
     /**
-     * @phpstan-param int $uid
-     * @phpstan-return TEntityClass|null
+     * @param int $uid The identifier of the object to find
+     * @return object|null The matching object if found, otherwise NULL
+     * @phpstan-return T|null
      */
     public function findByUid($uid);
 
     /**
-     * @phpstan-param int $identifier
-     * @phpstan-return TEntityClass|null
+     * @param mixed $identifier The identifier of the object to find
+     * @return object|null The matching object if found, otherwise NULL
+     * @phpstan-return T|null
      */
     public function findByIdentifier($identifier);
 
@@ -53,19 +64,13 @@ class Repository
     public function setDefaultOrderings($defaultOrderings);
 
     /**
-     * @phpstan-return QueryInterface<TEntityClass>
+     * @return QueryInterface
+     * @phpstan-return QueryInterface<T>
      */
     public function createQuery();
 
     /**
      * @phpstan-return class-string<static>
      */
     protected function getRepositoryClassName();
-
-    /**
-     * @phpstan-param array<non-empty-string, mixed> $criteria
-     * @phpstan-param array<non-empty-string, QueryInterface::ORDER_*>|null $orderBy
-     * @phpstan-return QueryResultInterface<TEntityClass>|list<TEntityClass>
-     */
-    public function findBy(array $criteria, array $orderBy = null, int $limit = null, int $offset = null);
 }

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

@@ -26,9 +26,6 @@ class FrontendUserGroupRepository extends Repository
 class FrontendUserGroupCustomFindAllRepository extends Repository
 {
 
-	/**
-	 * @return QueryResultInterface<FrontendUserGroup>
-	 */
 	public function findAll(): QueryResultInterface // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint
 	{
 		$queryResult = null; // phpcs:ignore SlevomatCodingStandard.Variables.UselessVariable.UselessVariable

tests/Unit/Type/data/repository-stub-files.php

@@ -156,14 +156,9 @@ class FindAllWithoutReturnTestRepository extends \TYPO3\CMS\Extbase\Persistence\
 	public function myTests(): void
 	{
 		assertType(
-			'array<int, RepositoryStubFiles\My\Test\Extension\Domain\Model\MyModel>|TYPO3\CMS\Extbase\Persistence\QueryResultInterface<RepositoryStubFiles\My\Test\Extension\Domain\Model\MyModel>',
+			'TYPO3\CMS\Extbase\Persistence\QueryResultInterface<RepositoryStubFiles\My\Test\Extension\Domain\Model\MyModel>',
 			$this->findAll()
 		);
-
-		assertType(
-			'array<int, RepositoryStubFiles\My\Test\Extension\Domain\Model\MyModel>|TYPO3\CMS\Extbase\Persistence\QueryResultInterface<RepositoryStubFiles\My\Test\Extension\Domain\Model\MyModel>',
-			$this->findBy(['foo' => 'baz'])
-		);
 	}
 
 	public function findAll() // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingAnyTypeHint