Allow an input and an output for a given resource class

api-platform · Nov 2, 2018 · cb5421a · cb5421a
1 parent c24b677
commit cb5421a
Show file tree

Hide file tree

Showing 22 changed files with 395 additions and 24 deletions.
diff --git a/src/Annotation/ApiResource.php b/src/Annotation/ApiResource.php
@@ -37,11 +37,13 @@
  *     @Attribute("filters", type="string[]"),
  *     @Attribute("graphql", type="array"),
  *     @Attribute("hydraContext", type="array"),
+ *     @Attribute("inputClass", type="string"),
  *     @Attribute("iri", type="string"),
  *     @Attribute("itemOperations", type="array"),
  *     @Attribute("maximumItemsPerPage", type="int"),
  *     @Attribute("normalizationContext", type="array"),
  *     @Attribute("order", type="array"),
+ *     @Attribute("outputClass", type="string"),
  *     @Attribute("paginationClientEnabled", type="bool"),
  *     @Attribute("paginationClientItemsPerPage", type="bool"),
  *     @Attribute("paginationClientPartial", type="bool"),
@@ -264,6 +266,20 @@ final class ApiResource
      */
     private $sunset;
 
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var string
+     */
+    private $inputClass;
+
+    /**
+     * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112
+     *
+     * @var string
+     */
+    private $outputClass;
+
     /**
      * @throws InvalidArgumentException
      */

diff --git a/src/Bridge/Symfony/Routing/ApiLoader.php b/src/Bridge/Symfony/Routing/ApiLoader.php
@@ -123,6 +123,8 @@ public function load($data, $type = null): RouteCollection
                         '_controller' => $controller,
                         '_format' => null,
                         '_api_resource_class' => $operation['resource_class'],
+                        '_api_input_class' => $operation['input_class'],
+                        '_api_output_class' => $operation['output_class'],
                         '_api_subresource_operation_name' => $operation['route_name'],
                         '_api_subresource_context' => [
                             'property' => $operation['property'],
@@ -210,6 +212,8 @@ private function addRoute(RouteCollection $routeCollection, string $resourceClas
                 '_controller' => $controller,
                 '_format' => null,
                 '_api_resource_class' => $resourceClass,
+                '_api_input_class' => $resourceMetadata->getAttribute('input_class', $resourceClass),
+                '_api_output_class' => $resourceMetadata->getAttribute('output_class', $resourceClass),
                 sprintf('_api_%s_operation_name', $operationType) => $operationName,
             ] + ($operation['defaults'] ?? []),
             $operation['requirements'] ?? [],

diff --git a/src/DataProvider/OperationDataProviderTrait.php b/src/DataProvider/OperationDataProviderTrait.php
@@ -49,7 +49,7 @@ trait OperationDataProviderTrait
      */
     private function getCollectionData(array $attributes, array $context)
     {
-        return $this->collectionDataProvider->getCollection($attributes['resource_class'], $attributes['collection_operation_name'], $context);
+        return $this->collectionDataProvider->getCollection($attributes['output_class'], $attributes['collection_operation_name'], $context);
     }
 
     /**
@@ -59,7 +59,7 @@ private function getCollectionData(array $attributes, array $context)
      */
     private function getItemData($identifiers, array $attributes, array $context)
     {
-        return $this->itemDataProvider->getItem($attributes['resource_class'], $identifiers, $attributes['item_operation_name'], $context);
+        return $this->itemDataProvider->getItem($attributes['output_class'], $identifiers, $attributes['item_operation_name'], $context);
     }
 
     /**
@@ -75,7 +75,7 @@ private function getSubresourceData($identifiers, array $attributes, array $cont
             throw new RuntimeException('Subresources not supported');
         }
 
-        return $this->subresourceDataProvider->getSubresource($attributes['resource_class'], $identifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);
+        return $this->subresourceDataProvider->getSubresource($attributes['output_class'], $identifiers, $attributes['subresource_context'] + $context, $attributes['subresource_operation_name']);
     }
 
     /**
@@ -93,7 +93,7 @@ private function extractIdentifiers(array $parameters, array $attributes)
             $id = $parameters['id'];
 
             if (null !== $this->identifierConverter) {
-                return $this->identifierConverter->convert((string) $id, $attributes['resource_class']);
+                return $this->identifierConverter->convert((string) $id, $attributes['output_class']);
             }
 
             return $id;

diff --git a/src/EventListener/DeserializeListener.php b/src/EventListener/DeserializeListener.php
@@ -81,6 +81,9 @@ public function onKernelRequest(GetResponseEvent $event)
 
         $format = $this->getFormat($request);
         $context = $this->serializerContextBuilder->createFromRequest($request, false, $attributes);
+        if (isset($context['input_class'])) {
+            $context['resource_class'] = $context['input_class'];
+        }
 
         $data = $request->attributes->get('data');
         if (null !== $data) {
@@ -90,7 +93,7 @@ public function onKernelRequest(GetResponseEvent $event)
         $request->attributes->set(
             'data',
             $this->serializer->deserialize(
-                $requestContent, $attributes['resource_class'], $format, $context
+                $requestContent, $attributes['input_class'], $format, $context
             )
         );
     }

diff --git a/src/EventListener/SerializeListener.php b/src/EventListener/SerializeListener.php
@@ -63,6 +63,10 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
         }
         $resources = new ResourceList();
         $context['resources'] = &$resources;
+        if (isset($context['output_class'])) {
+            $context['resource_class'] = $context['output_class'];
+        }
+
         $request->attributes->set('_api_normalization_context', $context);
 
         $event->setControllerResult($this->serializer->serialize($controllerResult, $request->getRequestFormat(), $context));

diff --git a/src/EventListener/WriteListener.php b/src/EventListener/WriteListener.php
@@ -61,7 +61,10 @@ public function onKernelView(GetResponseForControllerResultEvent $event)
 
                 $event->setControllerResult($persistResult ?? $controllerResult);
 
-                if (null !== $this->iriConverter) {
+                // Controller result must be immutable for _api_write_item_iri
+                // if it's class changed compared to the base class let's avoid calling the IriConverter
+                // especially that the Output class could be a DTO that's not referencing any route
+                if (null !== $this->iriConverter && \get_class($controllerResult) === \get_class($event->getControllerResult())) {
                     $request->attributes->set('_api_write_item_iri', $this->iriConverter->getIriFromItem($controllerResult));
                 }
                 break;

diff --git a/src/Operation/Factory/SubresourceOperationFactory.php b/src/Operation/Factory/SubresourceOperationFactory.php
@@ -106,6 +106,8 @@ private function computeSubresourceOperations(string $resourceClass, array &$tre
                 'collection' => $subresource->isCollection(),
                 'resource_class' => $subresourceClass,
                 'shortNames' => [$subresourceMetadata->getShortName()],
+                'input_class' => $subresourceMetadata->getAttribute('input_class', $subresourceClass),
+                'output_class' => $subresourceMetadata->getAttribute('output_class', $subresourceClass),
             ];
 
             if (null === $parentOperation) {

diff --git a/src/Serializer/SerializerContextBuilder.php b/src/Serializer/SerializerContextBuilder.php
@@ -73,6 +73,8 @@ public function createFromRequest(Request $request, bool $normalization, array $
         }
 
         $context['resource_class'] = $attributes['resource_class'];
+        $context['input_class'] = $attributes['input_class'] ?? $attributes['resource_class'];
+        $context['output_class'] = $attributes['output_class'] ?? $attributes['resource_class'];
         $context['request_uri'] = $request->getRequestUri();
         $context['uri'] = $request->getUri();
 

diff --git a/src/Util/AttributesExtractor.php b/src/Util/AttributesExtractor.php
@@ -35,6 +35,8 @@ private function __construct()
     public static function extractAttributes(array $attributes): array
     {
         $result = ['resource_class' => $attributes['_api_resource_class'] ?? null];
+        $result['input_class'] = $attributes['_api_input_class'] ?? $result['resource_class'];
+        $result['output_class'] = $attributes['_api_output_class'] ?? $result['resource_class'];
 
         if ($subresourceContext = $attributes['_api_subresource_context'] ?? null) {
             $result['subresource_context'] = $subresourceContext;

diff --git a/tests/Bridge/Symfony/Bundle/DataCollector/RequestDataCollectorTest.php b/tests/Bridge/Symfony/Bundle/DataCollector/RequestDataCollectorTest.php
@@ -136,7 +136,7 @@ public function testWithResource()
             $this->response
         );
 
-        $this->assertSame(['resource_class' => DummyEntity::class,  'item_operation_name' => 'get', 'receive' => true, 'persist' => true], $dataCollector->getRequestAttributes());
+        $this->assertSame(['resource_class' => DummyEntity::class, 'input_class' => DummyEntity::class, 'output_class' => DummyEntity::class, 'item_operation_name' => 'get', 'receive' => true, 'persist' => true], $dataCollector->getRequestAttributes());
         $this->assertSame(['foo', 'bar'], $dataCollector->getAcceptableContentTypes());
         $this->assertSame(DummyEntity::class, $dataCollector->getResourceClass());
         $this->assertSame(['foo' => null, 'a_filter' => \stdClass::class], $dataCollector->getFilters());

diff --git a/tests/Bridge/Symfony/Routing/ApiLoaderTest.php b/tests/Bridge/Symfony/Routing/ApiLoaderTest.php
@@ -305,6 +305,8 @@ private function getRoute(string $path, string $controller, string $resourceClas
                 '_controller' => $controller,
                 '_format' => null,
                 '_api_resource_class' => $resourceClass,
+                '_api_input_class' => $resourceClass,
+                '_api_output_class' => $resourceClass,
                 sprintf('_api_%s_operation_name', $collection ? 'collection' : 'item') => $operationName,
             ] + $extraDefaults,
             $requirements,
@@ -324,6 +326,8 @@ private function getSubresourceRoute(string $path, string $controller, string $r
                 '_controller' => $controller,
                 '_format' => null,
                 '_api_resource_class' => $resourceClass,
+                '_api_input_class' => $resourceClass,
+                '_api_output_class' => $resourceClass,
                 '_api_subresource_operation_name' => $operationName,
                 '_api_subresource_context' => $context,
             ],

diff --git a/tests/EventListener/AddFormatListenerTest.php b/tests/EventListener/AddFormatListenerTest.php
@@ -224,7 +224,7 @@ public function testResourceClassSupportedRequestFormat()
         $event = $eventProphecy->reveal();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'get', 'receive' => true, 'persist' => true])->willReturn(['csv' => ['text/csv']])->shouldBeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'input_class' => 'Foo', 'output_class' => 'Foo', 'collection_operation_name' => 'get', 'receive' => true, 'persist' => true])->willReturn(['csv' => ['text/csv']])->shouldBeCalled();
 
         $listener = new AddFormatListener(new Negotiator(), $formatsProviderProphecy->reveal());
         $listener->onKernelRequest($event);

diff --git a/tests/EventListener/DeserializeListenerTest.php b/tests/EventListener/DeserializeListenerTest.php
@@ -172,7 +172,7 @@ public function testDeserializeResourceClassSupportedFormat(string $method, bool
         $serializerContextBuilderProphecy->createFromRequest(Argument::type(Request::class), false, Argument::type('array'))->willReturn([])->shouldBeCalled();
 
         $formatsProviderProphecy = $this->prophesize(FormatsProviderInterface::class);
-        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true, 'persist' => true])->willReturn(self::FORMATS)->shouldBeCalled();
+        $formatsProviderProphecy->getFormatsFromAttributes(['resource_class' => 'Foo', 'input_class' => 'Foo', 'output_class' => 'Foo', 'collection_operation_name' => 'post', 'receive' => true, 'persist' => true])->willReturn(self::FORMATS)->shouldBeCalled();
 
         $listener = new DeserializeListener($serializerProphecy->reveal(), $serializerContextBuilderProphecy->reveal(), $formatsProviderProphecy->reveal());
 

diff --git a/tests/Fixtures/TestBundle/DataPersister/DummyInputDataPersister.php b/tests/Fixtures/TestBundle/DataPersister/DummyInputDataPersister.php
@@ -0,0 +1,46 @@
+<?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\Tests\Fixtures\TestBundle\DataPersister;
+
+use ApiPlatform\Core\DataPersister\DataPersisterInterface;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyInput;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyOutput;
+
+class DummyInputDataPersister implements DataPersisterInterface
+{
+    public function supports($data): bool
+    {
+        return $data instanceof DummyInput;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function persist($data)
+    {
+        $output = new DummyOutput();
+        $output->name = $data->name;
+        $output->id = 1;
+
+        return $output;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function remove($data)
+    {
+        return null;
+    }
+}
diff --git a/tests/Fixtures/TestBundle/Entity/DummyInput.php b/tests/Fixtures/TestBundle/Entity/DummyInput.php
@@ -0,0 +1,40 @@
+<?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\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+
+/**
+ * Dummy Input.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @ApiResource
+ */
+class DummyInput
+{
+    /**
+     * @var int The id
+     * @ApiProperty(identifier=true)
+     */
+    public $id;
+
+    /**
+     * @var string The dummy name
+     *
+     * @ApiProperty
+     */
+    public $name;
+}
diff --git a/tests/Fixtures/TestBundle/Entity/DummyInputOutput.php b/tests/Fixtures/TestBundle/Entity/DummyInputOutput.php
@@ -0,0 +1,33 @@
+<?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\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+
+/**
+ * Dummy InputOutput.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @ApiResource(attributes={"input_class"=DummyInput::class, "output_class"=DummyOutput::class})
+ */
+class DummyInputOutput
+{
+    /**
+     * @var int The id
+     * @ApiProperty(identifier=true)
+     */
+    public $id;
+}
diff --git a/tests/Fixtures/TestBundle/Entity/DummyOutput.php b/tests/Fixtures/TestBundle/Entity/DummyOutput.php
@@ -0,0 +1,46 @@
+<?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\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Dummy Output.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @ApiResource
+ * @ORM\Entity
+ */
+class DummyOutput
+{
+    /**
+     * @var int The id
+     *
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    public $id;
+
+    /**
+     * @var string The dummy name
+     *
+     * @ORM\Column
+     * @ApiProperty(iri="http://schema.org/name")
+     */
+    public $name;
+}
diff --git a/tests/Fixtures/app/config/config_test.yml b/tests/Fixtures/app/config/config_test.yml
@@ -241,3 +241,9 @@ services:
     app.dummy_validation.group_generator:
         class: ApiPlatform\Core\Tests\Fixtures\TestBundle\Validator\DummyValidationGroupsGenerator
         public: true
+
+    app.dummy_input_data_persister:
+        class: ApiPlatform\Core\Tests\Fixtures\TestBundle\DataPersister\DummyInputDataPersister
+        public: false
+        tags:
+            -  { name: 'api_platform.data_persister' }