Merge pull request #737 from soyuka/add-result-extension-item

Add QueryResultItemExtensionInterface

Author: dunglas

src/Bridge/Doctrine/Orm/CollectionDataProvider.php

@@ -12,7 +12,7 @@
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm;
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultExtensionInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
@@ -60,10 +60,8 @@ public function getCollection(string $resourceClass, string $operationName = nul
         foreach ($this->collectionExtensions as $extension) {
             $extension->applyToCollection($queryBuilder, $queryNameGenerator, $resourceClass, $operationName);
 
-            if ($extension instanceof QueryResultExtensionInterface) {
-                if ($extension->supportsResult($resourceClass, $operationName)) {
-                    return $extension->getResult($queryBuilder);
-                }
+            if ($extension instanceof QueryResultCollectionExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
+                return $extension->getResult($queryBuilder);
             }
         }
 

src/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -20,7 +20,7 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
  */
-class OrderExtension implements QueryCollectionExtensionInterface
+final class OrderExtension implements QueryCollectionExtensionInterface
 {
     private $order;
 

src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php

@@ -28,7 +28,7 @@
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
  */
-class PaginationExtension implements QueryResultExtensionInterface
+final class PaginationExtension implements QueryResultCollectionExtensionInterface
 {
     private $managerRegistry;
     private $requestStack;

src/Bridge/Doctrine/Orm/Extension/QueryResultExtensionInterface.php renamed to src/Bridge/Doctrine/Orm/Extension/QueryResultCollectionExtensionInterface.php

@@ -20,7 +20,7 @@
  * @author Samuel ROZE <[email protected]>
  * @author Kévin Dunglas <[email protected]>
  */
-interface QueryResultExtensionInterface extends QueryCollectionExtensionInterface
+interface QueryResultCollectionExtensionInterface extends QueryCollectionExtensionInterface
 {
     /**
      * @param string      $resourceClass

src/Bridge/Doctrine/Orm/Extension/QueryResultItemExtensionInterface.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
+
+use Doctrine\ORM\QueryBuilder;
+
+/**
+ * Interface of Doctrine ORM query extensions that supports result production
+ * for specific cases such as Query alteration.
+ *
+ * @author Antoine BLUCHET <[email protected]>
+ */
+interface QueryResultItemExtensionInterface extends QueryItemExtensionInterface
+{
+    /**
+     * @param string      $resourceClass
+     * @param string|null $operationName
+     *
+     * @return bool
+     */
+    public function supportsResult(string $resourceClass, string $operationName = null) : bool;
+
+    /**
+     * @param QueryBuilder $queryBuilder
+     *
+     * @return mixed
+     */
+    public function getResult(QueryBuilder $queryBuilder);
+}

src/Bridge/Doctrine/Orm/ItemDataProvider.php

@@ -12,9 +12,10 @@
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm;
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
-use ApiPlatform\Core\Exception\InvalidArgumentException;
+use ApiPlatform\Core\Exception\PropertyNotFoundException;
 use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
@@ -74,6 +75,10 @@ public function getItem(string $resourceClass, $id, string $operationName = null
 
         foreach ($this->itemExtensions as $extension) {
             $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName);
+
+            if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName)) {
+                return $extension->getResult($queryBuilder);
+            }
         }
 
         return $queryBuilder->getQuery()->getOneOrNullResult();
@@ -87,10 +92,6 @@ public function getItem(string $resourceClass, $id, string $operationName = null
      */
     private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryBuilder)
     {
-        if (empty($identifiers)) {
-            return;
-        }
-
         foreach ($identifiers as $identifier => $value) {
             $placeholder = ':id_'.$identifier;
             $expression = $queryBuilder->expr()->eq(
@@ -140,10 +141,10 @@ private function normalizeIdentifiers($id, ObjectManager $manager, string $resou
                 continue;
             }
 
-            $identifier = $identifiersMap[$propertyName] ?? $identifierValues[$i] ?? null;
+            $identifier = !isset($identifiersMap) ? $identifierValues[$i] ?? null : $identifiersMap[$propertyName] ?? null;
 
             if (null === $identifier) {
-                throw new InvalidArgumentException(sprintf('Invalid identifier "%s".', $id));
+                throw new PropertyNotFoundException(sprintf('Invalid identifier "%s", "%s" has not been found.', $id, $propertyName));
             }
 
             $identifiers[$propertyName] = $identifier;

tests/Bridge/Doctrine/Orm/CollectionDataProviderTest.php

@@ -13,7 +13,7 @@
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\CollectionDataProvider;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultExtensionInterface;
+use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use Doctrine\Common\Persistence\ManagerRegistry;
@@ -47,10 +47,10 @@ public function testGetCollection()
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn($managerProphecy->reveal())->shouldBeCalled();
 
-        $exstensionProphecy = $this->prophesize(QueryCollectionExtensionInterface::class);
-        $exstensionProphecy->applyToCollection($queryBuilder, Argument::type(QueryNameGeneratorInterface::class), Dummy::class, 'foo')->shouldBeCalled();
+        $extensionProphecy = $this->prophesize(QueryCollectionExtensionInterface::class);
+        $extensionProphecy->applyToCollection($queryBuilder, Argument::type(QueryNameGeneratorInterface::class), Dummy::class, 'foo')->shouldBeCalled();
 
-        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$exstensionProphecy->reveal()]);
+        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$extensionProphecy->reveal()]);
         $this->assertEquals([], $dataProvider->getCollection(Dummy::class, 'foo'));
     }
 
@@ -68,12 +68,12 @@ public function testQueryResultExtension()
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn($managerProphecy->reveal())->shouldBeCalled();
 
-        $exstensionProphecy = $this->prophesize(QueryResultExtensionInterface::class);
-        $exstensionProphecy->applyToCollection($queryBuilder, Argument::type(QueryNameGeneratorInterface::class), Dummy::class, 'foo')->shouldBeCalled();
-        $exstensionProphecy->supportsResult(Dummy::class, 'foo')->willReturn(true)->shouldBeCalled();
-        $exstensionProphecy->getResult($queryBuilder)->willReturn([])->shouldBeCalled();
+        $extensionProphecy = $this->prophesize(QueryResultCollectionExtensionInterface::class);
+        $extensionProphecy->applyToCollection($queryBuilder, Argument::type(QueryNameGeneratorInterface::class), Dummy::class, 'foo')->shouldBeCalled();
+        $extensionProphecy->supportsResult(Dummy::class, 'foo')->willReturn(true)->shouldBeCalled();
+        $extensionProphecy->getResult($queryBuilder)->willReturn([])->shouldBeCalled();
 
-        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$exstensionProphecy->reveal()]);
+        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$extensionProphecy->reveal()]);
         $this->assertEquals([], $dataProvider->getCollection(Dummy::class, 'foo'));
     }
 
@@ -103,9 +103,9 @@ public function testThrowResourceClassNotSupportedException()
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn(null)->shouldBeCalled();
 
-        $extenstensionProphecy = $this->prophesize(QueryResultExtensionInterface::class);
+        $extensionProphecy = $this->prophesize(QueryResultCollectionExtensionInterface::class);
 
-        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$extenstensionProphecy->reveal()]);
+        $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$extensionProphecy->reveal()]);
         $dataProvider->getCollection(Dummy::class, 'foo');
     }
 }