Deserialize in a view listener

src/Action/GetCollectionAction.php

@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Action;
 
+use ApiPlatform\Core\Api\RequestAttributesExtractor;
 use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
 use ApiPlatform\Core\DataProvider\PaginatorInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
@@ -23,8 +24,6 @@
  */
 final class GetCollectionAction
 {
-    use ActionUtilTrait;
-
     private $collectionDataProvider;
 
     public function __construct(CollectionDataProviderInterface $collectionDataProvider)
@@ -43,7 +42,7 @@ public function __construct(CollectionDataProviderInterface $collectionDataProvi
      */
     public function __invoke(Request $request)
     {
-        list($resourceClass, $operationName) = $this->extractAttributes($request);
+        list($resourceClass, $operationName) = RequestAttributesExtractor::extractAttributes($request);
 
         return $this->collectionDataProvider->getCollection($resourceClass, $operationName);
     }

src/Action/GetItemAction.php

@@ -11,6 +11,7 @@
 
 namespace ApiPlatform\Core\Action;
 
+use ApiPlatform\Core\Api\RequestAttributesExtractor;
 use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
 use Symfony\Component\HttpFoundation\Request;
@@ -23,8 +24,6 @@
  */
 final class GetItemAction
 {
-    use ActionUtilTrait;
-
     private $itemDataProvider;
 
     public function __construct(ItemDataProviderInterface $itemDataProvider)
@@ -45,8 +44,13 @@ public function __construct(ItemDataProviderInterface $itemDataProvider)
      */
     public function __invoke(Request $request, $id)
     {
-        list($resourceClass, , $operationName) = $this->extractAttributes($request);
+        list($resourceClass, , $operationName) = RequestAttributesExtractor::extractAttributes($request);
+
+        $data = $this->itemDataProvider->getItem($resourceClass, $id, $operationName, true);
+        if (!$data) {
+            throw new NotFoundHttpException('Not Found');
+        }
 
-        return $this->getItem($this->itemDataProvider, $resourceClass, $operationName, $id);
+        return $data;
     }
 }

src/Action/NullAction.php

@@ -0,0 +1,25 @@
+<?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\Action;
+
+/**
+ * Empty action. Useful to trigger the kernel.view event without doing anything specific in the action
+ * (e.g. the POST action).
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+final class NullAction
+{
+    public function __invoke()
+    {
+    }
+}

src/Action/ActionUtilTrait.php → src/Api/RequestAttributesExtractor.php

@@ -9,44 +9,20 @@
  * file that was distributed with this source code.
  */
 
-namespace ApiPlatform\Core\Action;
+namespace ApiPlatform\Core\Api;
 
-use ApiPlatform\Core\DataProvider\ItemDataProviderInterface;
 use ApiPlatform\Core\Exception\RuntimeException;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 /**
- * Checks if the request is properly configured.
+ * Extracts data used by the library form a Request instance.
  *
  * @author Kévin Dunglas <[email protected]>
  */
-trait ActionUtilTrait
+final class RequestAttributesExtractor
 {
     /**
-     * Gets an item using the data provider. Throws a 404 error if not found.
-     *
-     * @param ItemDataProviderInterface $itemDataProvider
-     * @param string                    $resourceClass
-     * @param string                    $operationName
-     * @param string|int                $id
-     *
-     * @throws NotFoundHttpException
-     *
-     * @return object
-     */
-    private function getItem(ItemDataProviderInterface $itemDataProvider, string $resourceClass, string $operationName, $id)
-    {
-        $data = $itemDataProvider->getItem($resourceClass, $id, $operationName, true);
-        if (!$data) {
-            throw new NotFoundHttpException('Not Found');
-        }
-
-        return $data;
-    }
-
-    /**
-     * Extract resource class, operation name and format request attributes. Throws an exception if the request does not contain required
+     * Extracts resource class, operation name and format request attributes. Throws an exception if the request does not contain required
      * attributes.
      *
      * @param Request $request
@@ -55,7 +31,7 @@ private function getItem(ItemDataProviderInterface $itemDataProvider, string $re
      *
      * @return array
      */
-    private function extractAttributes(Request $request)
+    public static function extractAttributes(Request $request)
     {
         $resourceClass = $request->attributes->get('_resource_class');
 

src/Bridge/Symfony/Bundle/Resources/config/api.xml

@@ -58,6 +58,12 @@
             <tag name="kernel.event_listener" event="kernel.request" method="onKernelRequest" />
         </service>
 
+        <service id="api_platform.listener.view.deserializer" class="ApiPlatform\Core\EventListener\DeserializerViewListener">
+            <argument type="service" id="api_platform.serializer" />
+
+            <tag name="kernel.event_listener" event="kernel.view" method="onKernelView" priority="30" />
+        </service>
+
         <service id="api_platform.listener.view.validation" class="ApiPlatform\Core\Bridge\Symfony\Validator\EventListener\ViewListener">
             <argument type="service" id="api_platform.metadata.resource.metadata_factory" />
             <argument type="service" id="validator" />
@@ -71,18 +77,13 @@
             <argument type="service" id="api_platform.collection_data_provider" />
         </service>
 
-        <service id="api_platform.action.post_collection" class="ApiPlatform\Core\Action\PostCollectionAction">
-            <argument type="service" id="api_platform.serializer" />
-        </service>
+        <service id="api_platform.action.post_collection" class="ApiPlatform\Core\Action\NullAction" />
 
         <service id="api_platform.action.get_item" class="ApiPlatform\Core\Action\GetItemAction">
             <argument type="service" id="api_platform.item_data_provider" />
         </service>
 
-        <service id="api_platform.action.put_item" class="ApiPlatform\Core\Action\PutItemAction">
-            <argument type="service" id="api_platform.item_data_provider" />
-            <argument type="service" id="api_platform.serializer" />
-        </service>
+        <service id="api_platform.action.put_item" alias="api_platform.action.get_item" />
 
         <service id="api_platform.action.delete_item" alias="api_platform.action.get_item" />
     </services>

src/EventListener/DeserializerViewListener.php

@@ -0,0 +1,63 @@
+<?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\EventListener;
+
+use ApiPlatform\Core\Api\RequestAttributesExtractor;
+use ApiPlatform\Core\Exception\RuntimeException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
+use Symfony\Component\Serializer\SerializerInterface;
+
+/**
+ * Updates the entity retrieved by the data provider with data contained in the request body.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+final class DeserializerViewListener
+{
+    private $serializer;
+
+    public function __construct(SerializerInterface $serializer)
+    {
+        $this->serializer = $serializer;
+    }
+
+    public function onKernelView(GetResponseForControllerResultEvent $event)
+    {
+        $data = $event->getControllerResult();
+        $request = $event->getRequest();
+
+        if ($data instanceof Response || !in_array($request->getMethod(), [Request::METHOD_POST, Request::METHOD_PUT], true)) {
+            return;
+        }
+
+        try {
+            list($resourceClass, $collectionOperation, $itemOperation, $format) = RequestAttributesExtractor::extractAttributes($request);
+        } catch (RuntimeException $e) {
+            return;
+        }
+
+        $context = ['resource_class' => $resourceClass];
+        if ($collectionOperation) {
+            $context['collection_operation_name'] = $collectionOperation;
+        } else {
+            $context['item_operation_name'] = $itemOperation;
+        }
+
+        if (null !== $data) {
+            $context['object_to_populate'] = $data;
+        }
+
+        $event->setControllerResult($this->serializer->deserialize($request->getContent(), $resourceClass, $format, $context));
+    }
+}

tests/Action/GetCollectionActionTest.php

@@ -0,0 +1,35 @@
+<?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\Tests\Action;
+
+use ApiPlatform\Core\Action\GetCollectionAction;
+use ApiPlatform\Core\DataProvider\CollectionDataProviderInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ */
+class GetCollectionActionTest extends \PHPUnit_Framework_TestCase
+{
+    public function testGetCollection()
+    {
+        $result = new \stdClass();
+
+        $dataProviderProphecy = $this->prophesize(CollectionDataProviderInterface::class);
+        $dataProviderProphecy->getCollection('Foo', 'get')->willReturn($result);
+
+        $request = new Request([], [], ['_resource_class' => 'Foo', '_collection_operation_name' => 'get', '_api_format' => 'json']);
+
+        $action = new GetCollectionAction($dataProviderProphecy->reveal());
+        $this->assertSame($result, $action($request));
+    }
+}