toIterable type support

Author: snapshotpl

README.md

@@ -18,7 +18,7 @@ This extension provides following features:
 * Adds missing `matching` method on `Doctrine\Common\Collections\Collection`. This can be turned off by setting `parameters.doctrine.allCollectionsSelectable` to `false`.
 * Also supports Doctrine ODM.
 * Analysis of discrepancies between entity column types and property field types. This can be relaxed with the `allowNullablePropertyForRequiredField: true` setting.
-* Provides return type for `Doctrine\ORM\Query::getResult`, `getOneOrNullResult`, `getSingleResult`, and `execute` in `HYDRATE_OBJECT` mode (see bellow).
+* Provides return type for `Doctrine\ORM\Query::getResult`, `getOneOrNullResult`, `getSingleResult`, `toIterable` and `execute` in `HYDRATE_OBJECT` mode (see bellow).
 
 ## Installation
 
@@ -140,7 +140,7 @@ $query->getResult(); // array<User>
 $query->getResult(Query::HYDRATE_OBJECT); // array<User>
 ```
 
-The methods `getOneOrNullResult`, `getSingleResult`, and `execute` are supported when the hydrateMode argument is explicitly set to `Query::HYDRATE_OBJECT`:
+The methods `getOneOrNullResult`, `getSingleResult`, `toIterable`, and `execute` are supported when the hydrateMode argument is explicitly set to `Query::HYDRATE_OBJECT`:
 
 ``` php
 $query = $entityManager->createQuery('SELECT u FROM Acme\User u');

src/Type/Doctrine/Query/QueryResultDynamicReturnTypeExtension.php

@@ -13,6 +13,7 @@
 use PHPStan\Type\DynamicMethodReturnTypeExtension;
 use PHPStan\Type\Generic\GenericObjectType;
 use PHPStan\Type\IntegerType;
+use PHPStan\Type\IterableType;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\NullType;
 use PHPStan\Type\Type;
@@ -24,6 +25,7 @@ final class QueryResultDynamicReturnTypeExtension implements DynamicMethodReturn
 
 	private const METHOD_HYDRATION_MODE_ARG = [
 		'getResult' => 0,
+		'toIterable' => 1,
 		'execute' => 1,
 		'executeIgnoreQueryCache' => 1,
 		'executeUsingQueryCache' => 1,
@@ -118,6 +120,11 @@ private function getMethodReturnTypeForHydrationMode(
 				return $queryResultType;
 			case 'getOneOrNullResult':
 				return TypeCombinator::addNull($queryResultType);
+			case 'toIterable':
+				return new IterableType(
+					new MixedType(),
+					$queryResultType
+				);
 			default:
 				return new ArrayType(
 					new MixedType(),

tests/Type/Doctrine/data/QueryResult/queryResult.php

@@ -44,6 +44,10 @@ public function testReturnTypeOfQueryMethodsWithImplicitHydrationMode(EntityMana
 			'array<QueryResult\Entities\Many>',
 			$query->getResult()
 		);
+		assertType(
+			'iterable<QueryResult\Entities\Many>',
+			$query->toIterable()
+		);
 		assertType(
 			'mixed',
 			$query->execute()
@@ -82,6 +86,10 @@ public function testReturnTypeOfQueryMethodsWithExplicitObjectHydrationMode(Enti
 			'array<QueryResult\Entities\Many>',
 			$query->getResult(AbstractQuery::HYDRATE_OBJECT)
 		);
+		assertType(
+			'iterable<QueryResult\Entities\Many>',
+			$query->toIterable([], AbstractQuery::HYDRATE_OBJECT)
+		);
 		assertType(
 			'array<QueryResult\Entities\Many>',
 			$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
@@ -150,6 +158,10 @@ public function testReturnTypeOfQueryMethodsWithExplicitNonObjectHydrationMode(E
 			'mixed',
 			$query->getResult(AbstractQuery::HYDRATE_ARRAY)
 		);
+		assertType(
+			'iterable',
+			$query->toIterable([], AbstractQuery::HYDRATE_ARRAY)
+		);
 		assertType(
 			'mixed',
 			$query->execute(null, AbstractQuery::HYDRATE_ARRAY)
@@ -190,6 +202,10 @@ public function testReturnTypeOfQueryMethodsWithExplicitNonConstantHydrationMode
 			'mixed',
 			$query->getResult($hydrationMode)
 		);
+		assertType(
+			'iterable',
+			$query->toIterable([], $hydrationMode)
+		);
 		assertType(
 			'mixed',
 			$query->execute(null, $hydrationMode)
@@ -224,6 +240,10 @@ public function testReturnTypeOfQueryMethodsWithReturnTypeIsMixed(EntityManagerI
 			'mixed',
 			$query->getResult(AbstractQuery::HYDRATE_OBJECT)
 		);
+		assertType(
+			'iterable',
+			$query->toIterable([], AbstractQuery::HYDRATE_OBJECT)
+		);
 		assertType(
 			'mixed',
 			$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
@@ -260,6 +280,10 @@ public function testReturnTypeOfQueryMethodsWithReturnTypeIsTemplateMixedType(En
 			'mixed',
 			$query->getResult(AbstractQuery::HYDRATE_OBJECT)
 		);
+		assertType(
+			'iterable',
+			$query->toIterable([], AbstractQuery::HYDRATE_OBJECT)
+		);
 		assertType(
 			'mixed',
 			$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
@@ -296,6 +320,10 @@ public function testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(Enti
 			'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
 			$query->getResult(AbstractQuery::HYDRATE_OBJECT)
 		);
+		assertType(
+			'iterable<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
+			$query->toIterable([], AbstractQuery::HYDRATE_OBJECT)
+		);
 		assertType(
 			'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
 			$query->execute(null, AbstractQuery::HYDRATE_OBJECT)