Generator compat improvements

src/Bridge/Doctrine/Orm/CollectionDataProvider.php

@@ -17,7 +17,7 @@
 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;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
 use Doctrine\Common\Persistence\ManagerRegistry;
 
@@ -27,7 +27,7 @@
  * @author Kévin Dunglas <dunglas@gmail.com>
  * @author Samuel ROZE <samuel.roze@gmail.com>
  */
-class CollectionDataProvider implements CollectionDataProviderInterface
+class CollectionDataProvider implements CollectionDataProviderInterface, RestrictedDataProviderInterface
 {
     private $managerRegistry;
     private $collectionExtensions;
@@ -42,6 +42,11 @@ public function __construct(ManagerRegistry $managerRegistry, array $collectionE
         $this->collectionExtensions = $collectionExtensions;
     }
 
+    public function supports(string $resourceClass, string $operationName = null): bool
+    {
+        return null !== $this->managerRegistry->getManagerForClass($resourceClass);
+    }
+
     /**
      * {@inheritdoc}
      *
@@ -50,9 +55,6 @@ public function __construct(ManagerRegistry $managerRegistry, array $collectionE
     public function getCollection(string $resourceClass, string $operationName = null)
     {
         $manager = $this->managerRegistry->getManagerForClass($resourceClass);
-        if (null === $manager) {
-            throw new ResourceClassNotSupportedException();
-        }
 
         $repository = $manager->getRepository($resourceClass);
         if (!method_exists($repository, 'createQueryBuilder')) {

src/Bridge/Doctrine/Orm/ItemDataProvider.php

@@ -18,7 +18,7 @@
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\IdentifierManagerTrait;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
-use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
 use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
@@ -32,7 +32,7 @@
  * @author Kévin Dunglas <dunglas@gmail.com>
  * @author Samuel ROZE <samuel.roze@gmail.com>
  */
-class ItemDataProvider implements ItemDataProviderInterface
+class ItemDataProvider implements ItemDataProviderInterface, RestrictedDataProviderInterface
 {
     use IdentifierManagerTrait;
 
@@ -53,6 +53,11 @@ public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollec
         $this->itemExtensions = $itemExtensions;
     }
 
+    public function supports(string $resourceClass, string $operationName = null): bool
+    {
+        return null !== $this->managerRegistry->getManagerForClass($resourceClass);
+    }
+
     /**
      * {@inheritdoc}
      *
@@ -63,9 +68,6 @@ public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollec
     public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
     {
         $manager = $this->managerRegistry->getManagerForClass($resourceClass);
-        if (null === $manager) {
-            throw new ResourceClassNotSupportedException();
-        }
 
         $identifiers = $this->normalizeIdentifiers($id, $manager, $resourceClass);
 

src/DataProvider/ChainCollectionDataProvider.php

@@ -39,8 +39,14 @@ public function getCollection(string $resourceClass, string $operationName = nul
     {
         foreach ($this->dataProviders as $dataProvider) {
             try {
+                if ($dataProvider instanceof RestrictedDataProviderInterface
+                    && !$dataProvider->supports($resourceClass, $operationName)) {
+                    continue;
+                }
+
                 return $dataProvider->getCollection($resourceClass, $operationName);
             } catch (ResourceClassNotSupportedException $e) {
+                @trigger_error(sprintf('Throwing a "%s" in a data provider is deprecated in favor of implementing "%s"', ResourceClassNotSupportedException::class, RestrictedDataProviderInterface::class), E_USER_DEPRECATED);
                 continue;
             }
         }

src/DataProvider/ChainItemDataProvider.php

@@ -37,10 +37,16 @@ public function __construct(array $dataProviders)
      */
     public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
     {
-        foreach ($this->dataProviders as $dataProviders) {
+        foreach ($this->dataProviders as $dataProvider) {
             try {
-                return $dataProviders->getItem($resourceClass, $id, $operationName, $context);
+                if ($dataProvider instanceof RestrictedDataProviderInterface
+                    && !$dataProvider->supports($resourceClass, $operationName)) {
+                    continue;
+                }
+
+                return $dataProvider->getItem($resourceClass, $id, $operationName, $context);
             } catch (ResourceClassNotSupportedException $e) {
+                @trigger_error(sprintf('Throwing a "%s" is deprecated in favor of implementing "%s"', get_class($e), RestrictedDataProviderInterface::class), E_USER_DEPRECATED);
                 continue;
             }
         }

src/DataProvider/RestrictedDataProviderInterface.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\DataProvider;
+
+/**
+ * Restricts a data provider based on a condition.
+ */
+interface RestrictedDataProviderInterface
+{
+    public function supports(string $resourceClass, string $operationName = null): bool;
+}

tests/Bridge/Doctrine/Orm/CollectionDataProviderTest.php

@@ -98,17 +98,14 @@ public function testCannotCreateQueryBuilder()
         $this->assertEquals([], $dataProvider->getCollection(Dummy::class, 'foo'));
     }
 
-    /**
-     * @expectedException \ApiPlatform\Core\Exception\ResourceClassNotSupportedException
-     */
-    public function testThrowResourceClassNotSupportedException()
+    public function testUnsupportedClass()
     {
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn(null)->shouldBeCalled();
 
         $extensionProphecy = $this->prophesize(QueryResultCollectionExtensionInterface::class);
 
         $dataProvider = new CollectionDataProvider($managerRegistryProphecy->reveal(), [$extensionProphecy->reveal()]);
-        $dataProvider->getCollection(Dummy::class, 'foo');
+        $this->assertFalse($dataProvider->supports(Dummy::class, 'foo'));
     }
 }

tests/Bridge/Doctrine/Orm/ItemDataProviderTest.php

@@ -178,10 +178,7 @@ public function testQueryResultExtension()
         $this->assertEquals([], $dataProvider->getItem(Dummy::class, 1, 'foo'));
     }
 
-    /**
-     * @expectedException \ApiPlatform\Core\Exception\ResourceClassNotSupportedException
-     */
-    public function testThrowResourceClassNotSupportedException()
+    public function testUnsupportedClass()
     {
         $managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
         $managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn(null)->shouldBeCalled();
@@ -193,7 +190,7 @@ public function testThrowResourceClassNotSupportedException()
         ]);
 
         $dataProvider = new ItemDataProvider($managerRegistryProphecy->reveal(), $propertyNameCollectionFactory, $propertyMetadataFactory, [$extensionProphecy->reveal()]);
-        $dataProvider->getItem(Dummy::class, 'foo');
+        $this->assertFalse($dataProvider->supports(Dummy::class, 'foo'));
     }
 
     /**

tests/DataProvider/ChainCollectionDataProviderTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\DataProvider\ChainCollectionDataProvider;
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use PHPUnit\Framework\TestCase;
@@ -34,7 +35,57 @@ public function testGetCollection()
         $dummy2->setName('Parks');
 
         $firstDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
-        $firstDataProvider->getCollection(Dummy::class, null)->willReturn([$dummy, $dummy2])->willThrow(ResourceClassNotSupportedException::class);
+        $firstDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $firstDataProvider->supports(Dummy::class, null)->willReturn(false);
+
+        $secondDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
+        $secondDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $secondDataProvider->supports(Dummy::class, null)->willReturn(true);
+        $secondDataProvider->getCollection(Dummy::class, null)
+            ->willReturn([$dummy, $dummy2]);
+
+        $thirdDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
+        $thirdDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $thirdDataProvider->supports(Dummy::class, null)->willReturn(true);
+        $thirdDataProvider->getCollection(Dummy::class, null)->willReturn([$dummy]);
+
+        $chainItemDataProvider = new ChainCollectionDataProvider([
+            $firstDataProvider->reveal(),
+            $secondDataProvider->reveal(),
+            $thirdDataProvider->reveal(),
+        ]);
+
+        $this->assertEquals(
+            [$dummy, $dummy2],
+            $chainItemDataProvider->getCollection(Dummy::class)
+        );
+    }
+
+    public function testGetCollectionNotSupported()
+    {
+        $firstDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
+        $firstDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $firstDataProvider->supports('notfound', 'op')->willReturn(false);
+
+        $collection = (new ChainCollectionDataProvider([$firstDataProvider->reveal()]))->getCollection('notfound', 'op');
+
+        $this->assertTrue(is_array($collection) || $collection instanceof \Traversable);
+        $this->assertEmpty($collection);
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation Throwing a "ApiPlatform\Core\Exception\ResourceClassNotSupportedException" in a data provider is deprecated in favor of implementing "ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface"
+     */
+    public function testLegacyGetCollection()
+    {
+        $dummy = new Dummy();
+        $dummy->setName('Rosa');
+        $dummy2 = new Dummy();
+        $dummy2->setName('Parks');
+
+        $firstDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
+        $firstDataProvider->getCollection(Dummy::class, null)->willThrow(ResourceClassNotSupportedException::class);
 
         $secondDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
         $secondDataProvider->getCollection(Dummy::class, null)->willReturn([$dummy, $dummy2]);
@@ -47,7 +98,11 @@ public function testGetCollection()
         $this->assertEquals([$dummy, $dummy2], $chainItemDataProvider->getCollection(Dummy::class));
     }
 
-    public function testGetCollectionExceptions()
+    /**
+     * @group legacy
+     * @expectedDeprecation Throwing a "ApiPlatform\Core\Exception\ResourceClassNotSupportedException" in a data provider is deprecated in favor of implementing "ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface"
+     */
+    public function testLegacyGetCollectionExceptions()
     {
         $firstDataProvider = $this->prophesize(CollectionDataProviderInterface::class);
         $firstDataProvider->getCollection('notfound', 'op')->willThrow(ResourceClassNotSupportedException::class);

tests/DataProvider/ChainItemDataProviderTest.php

@@ -15,6 +15,7 @@
 
 use ApiPlatform\Core\DataProvider\ChainItemDataProvider;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use PHPUnit\Framework\TestCase;
@@ -31,6 +32,49 @@ public function testGetItem()
         $dummy = new Dummy();
         $dummy->setName('Lucie');
 
+        $firstDataProvider = $this->prophesize(ItemDataProviderInterface::class);
+        $firstDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $firstDataProvider->supports(Dummy::class, null)->willReturn(false);
+
+        $secondDataProvider = $this->prophesize(ItemDataProviderInterface::class);
+        $secondDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $secondDataProvider->supports(Dummy::class, null)->willReturn(true);
+        $secondDataProvider->getItem(Dummy::class, 1, null, [])->willReturn($dummy);
+
+        $thirdDataProvider = $this->prophesize(ItemDataProviderInterface::class);
+        $thirdDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $thirdDataProvider->supports(Dummy::class, null)->willReturn(true);
+        $thirdDataProvider->getItem(Dummy::class, 1, null, [])->willReturn(new \stdClass());
+
+        $chainItemDataProvider = new ChainItemDataProvider([
+            $firstDataProvider->reveal(),
+            $secondDataProvider->reveal(),
+            $thirdDataProvider->reveal(),
+        ]);
+
+        $this->assertEquals($dummy, $chainItemDataProvider->getItem(Dummy::class, 1));
+    }
+
+    public function testGetItemExceptions()
+    {
+        $firstDataProvider = $this->prophesize(ItemDataProviderInterface::class);
+        $firstDataProvider->willImplement(RestrictedDataProviderInterface::class);
+        $firstDataProvider->supports('notfound', null)->willReturn(false);
+
+        $chainItemDataProvider = new ChainItemDataProvider([$firstDataProvider->reveal()]);
+
+        $this->assertEquals('', $chainItemDataProvider->getItem('notfound', 1));
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation Throwing a "ApiPlatform\Core\Exception\ResourceClassNotSupportedException" is deprecated in favor of implementing "ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface"
+     */
+    public function testLegacyGetItem()
+    {
+        $dummy = new Dummy();
+        $dummy->setName('Lucie');
+
         $firstDataProvider = $this->prophesize(ItemDataProviderInterface::class);
         $firstDataProvider->getItem(Dummy::class, 1, null, [])->willThrow(ResourceClassNotSupportedException::class);
 
@@ -45,7 +89,11 @@ public function testGetItem()
         $this->assertEquals($dummy, $chainItemDataProvider->getItem(Dummy::class, 1));
     }
 
-    public function testGetItemExeptions()
+    /**
+     * @group legacy
+     * @expectedDeprecation Throwing a "ApiPlatform\Core\Exception\ResourceClassNotSupportedException" is deprecated in favor of implementing "ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface"
+     */
+    public function testLegacyGetItemExceptions()
     {
         $firstDataProvider = $this->prophesize(ItemDataProviderInterface::class);
         $firstDataProvider->getItem('notfound', 1, null, [])->willThrow(ResourceClassNotSupportedException::class);

tests/Fixtures/TestBundle/DataProvider/ContainNonResourceItemDataProvider.php

@@ -14,24 +14,25 @@
 namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\DataProvider;
 
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
-use ApiPlatform\Core\Exception\ResourceClassNotSupportedException;
+use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
 use ApiPlatform\Core\Tests\Fixtures\NotAResource;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\ContainNonResource;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class ContainNonResourceItemDataProvider implements ItemDataProviderInterface
+class ContainNonResourceItemDataProvider implements ItemDataProviderInterface, RestrictedDataProviderInterface
 {
+    public function supports(string $resourceClass, string $operationName = null): bool
+    {
+        return ContainNonResource::class === $resourceClass;
+    }
+
     /**
      * {@inheritdoc}
      */
     public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
     {
-        if (ContainNonResource::class !== $resourceClass) {
-            throw new ResourceClassNotSupportedException();
-        }
-
         // Retrieve the blog post item from somewhere
         $cnr = new ContainNonResource();
         $cnr->id = $id;