v3.0.0

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 3.0.0
+
+Breaking Change:
+ * The DTO annotation has been removed.
+ * You now need to implement the `DataTransferObjectInterface` to your DTO
+ * `DtoUtility::loadArrayToDto` is now available through the Symfony Serializer using the denormalizer.
+ * `DtoUtility::updateEntityList` is now available at `EntityUtils::updateCollection`
+ * You no longer need to declare the DTO as a service
+
+New feature:
+ * Implementation of a DTO normalizer/denormalizer for Symfony's Serializer
+
 ## 2.3.2
 
 Bug fix:

ChapleanDtoHandlerBundle.php

@@ -11,8 +11,6 @@
 
 namespace Chaplean\Bundle\DtoHandlerBundle;
 
-use Chaplean\Bundle\DtoHandlerBundle\DependencyInjection\Compiler\DataTransferObjectPass;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 /**
@@ -25,13 +23,4 @@
  */
 class ChapleanDtoHandlerBundle extends Bundle
 {
-    /**
-     * @param ContainerBuilder $container
-     *
-     * @return void
-     */
-    public function build(ContainerBuilder $container)
-    {
-        $container->addCompilerPass(new DataTransferObjectPass());
-    }
 }

DataTransferObject/DataTransferObjectInterface.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace Chaplean\Bundle\DtoHandlerBundle\DataTransferObject;
+
+/**
+ * Interface DataTransferObjectInterface
+ *
+ * @package   Chaplean\Bundle\DtoHandlerBundle\DataTransferObject
+ * @author    Nicolas Guilloux <nguilloux@richcongress.com>
+ * @copyright 2014 - 2020 RichCongress (https://www.richcongress.com)
+ */
+interface DataTransferObjectInterface
+{
+}

DependencyInjection/ChapleanDtoHandlerExtension.php

@@ -16,6 +16,13 @@
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
+/**
+ * Class ChapleanDtoHandlerExtension
+ *
+ * @package   Chaplean\Bundle\DtoHandlerBundle\DependencyInjection
+ * @author    Nicolas Guilloux <nguilloux@richcongress.com>
+ * @copyright 2014 - 2020 RichCongress (https://www.richcongress.com)
+ */
 class ChapleanDtoHandlerExtension extends Extension
 {
     /**
@@ -33,8 +40,8 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
-        $container->setParameter('chaplean_dto_handler', $config);
-        $this->setParameters($container, 'chaplean_dto_handler', $config);
+        $container->setParameter(Configuration::CONFIG_NODE, $config);
+        $this->setParameters($container, Configuration::CONFIG_NODE, $config);
     }
 
     /**

DependencyInjection/Configuration.php

@@ -20,13 +20,17 @@
  */
 final class Configuration implements ConfigurationInterface
 {
+    public const CONFIG_NODE = 'chaplean_dto_handler';
+
     /**
      * @return TreeBuilder
      */
     public function getConfigTreeBuilder(): TreeBuilder
     {
-        $treeBuilder = new TreeBuilder();
-        $rootNode = $treeBuilder->root('chaplean_dto_handler');
+        $treeBuilder = new TreeBuilder(self::CONFIG_NODE);
+        $rootNode = \method_exists(TreeBuilder::class, 'getRootNode')
+            ? $treeBuilder->getRootNode()
+            : $treeBuilder->root(self::CONFIG_NODE);
 
         $rootNode
             ->children()

EventListener/DataTransferObjectValidationExceptionSubscriber.php

@@ -5,7 +5,7 @@
 use Chaplean\Bundle\DtoHandlerBundle\Exception\DataTransferObjectValidationException;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
-use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+use Symfony\Component\HttpKernel\Event\ExceptionEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
 /**
@@ -27,13 +27,13 @@ public static function getSubscribedEvents(): array
     }
 
     /**
-     * @param GetResponseForExceptionEvent $event
+     * @param ExceptionEvent $event
      *
      * @return void
      */
-    public function onKernelException(GetResponseForExceptionEvent $event): void
+    public function onKernelException(ExceptionEvent $event): void
     {
-        $exception = $event->getException();
+        $exception = $event->getThrowable();
 
         if (!$exception instanceof DataTransferObjectValidationException) {
             return;

ParamConverter/DataTransferObjectParamConverter.php

@@ -11,11 +11,10 @@
 
 namespace Chaplean\Bundle\DtoHandlerBundle\ParamConverter;
 
-use Chaplean\Bundle\DtoHandlerBundle\Annotation\DTO;
 use Chaplean\Bundle\DtoHandlerBundle\ConfigurationExtractor\PropertyConfigurationExtractor;
+use Chaplean\Bundle\DtoHandlerBundle\DataTransferObject\DataTransferObjectInterface;
 use Chaplean\Bundle\DtoHandlerBundle\Exception\DataTransferObjectValidationException;
 use Doctrine\Common\Annotations\AnnotationException;
-use Doctrine\Common\Annotations\AnnotationReader;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
 use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterInterface;
 use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterManager;
@@ -182,9 +181,6 @@ public function apply(Request $originalRequest, ParamConverter $configuration):
      * @param ParamConverter $configuration
      *
      * @return boolean
-     *
-     * @throws \ReflectionException
-     * @throws AnnotationException
      */
     public function supports(ParamConverter $configuration): bool
     {
@@ -194,16 +190,7 @@ public function supports(ParamConverter $configuration): bool
             return false;
         }
 
-        if (\in_array($class, $this->taggedDtoClasses, true)) {
-            return true;
-        }
-
-        $propertyReflectionClass = new \ReflectionClass($class);
-
-        $annotationReader = new AnnotationReader();
-        $typeAnnotation = $annotationReader->getClassAnnotation($propertyReflectionClass, DTO::class);
-
-        return $typeAnnotation !== null;
+        return is_subclass_of($class, DataTransferObjectInterface::class);
     }
 
     /**

Resources/config/services.xml

@@ -20,10 +20,20 @@
             <tag name="request.param_converter" converter="data_transfer_object_converter" />
         </service>
 
-        <service id="Chaplean\Bundle\DtoHandlerBundle\Utility\DtoUtility">
+        <service id="Chaplean\Bundle\DtoHandlerBundle\Validator\Constraints\UniqueEntityDataValidator" />
+
+        <!-- Serializer -->
+        <service id="Chaplean\Bundle\DtoHandlerBundle\Serializer\DataTransferObjectDenormalizer">
             <argument key="$paramConverterManager" type="service" id="sensio_framework_extra.converter.manager" />
+            <tag name="serializer.denormalizer" priority="50" />
+        </service>
+        <service id="Chaplean\Bundle\DtoHandlerBundle\Serializer\DataTransferObjectNormalizer" lazy="true">
+            <argument key="$normalizer" type="service" id="serializer" />
+            <tag name="serializer.normalizer" priority="50" />
+        </service>
+        <service id="Chaplean\Bundle\DtoHandlerBundle\Serializer\EntityIdNormalizer">
+            <tag name="serializer.normalizer" priority="50" />
         </service>
 
-        <service id="Chaplean\Bundle\DtoHandlerBundle\Validator\Constraints\UniqueEntityDataValidator" />
     </services>
 </container>

Serializer/DataTransferObjectDenormalizer.php

@@ -0,0 +1,78 @@
+<?php declare(strict_types=1);
+
+namespace Chaplean\Bundle\DtoHandlerBundle\Serializer;
+
+use Chaplean\Bundle\DtoHandlerBundle\DataTransferObject\DataTransferObjectInterface;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
+use Sensio\Bundle\FrameworkExtraBundle\Request\ParamConverter\ParamConverterManager;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
+
+/**
+ * Class DataTransferObjectDenormalizer
+ *
+ * @package   Chaplean\Bundle\DtoHandlerBundle\Serializer
+ * @author    Nicolas Guilloux <nguilloux@richcongress.com>
+ * @copyright 2014 - 2020 RichCongress (https://www.richcongress.com)
+ */
+class DataTransferObjectDenormalizer implements DenormalizerInterface
+{
+    public const VALIDATION_CONTEXT_KEY = '_dto_validation';
+
+    /**
+     * @var ParamConverterManager
+     */
+    protected $paramConverterManager;
+
+    /**
+     * DtoUtility constructor.
+     *
+     * @param ParamConverterManager $paramConverterManager
+     */
+    public function __construct(ParamConverterManager $paramConverterManager)
+    {
+        $this->paramConverterManager = $paramConverterManager;
+    }
+
+    /**
+     * @param mixed  $data
+     * @param string $type
+     * @param null   $format
+     * @param array  $context
+     *
+     * @return array|object|void
+     */
+    public function denormalize($data, $type, $format = null, array $context = [])
+    {
+        $request = new Request(
+            [],
+            $data,
+            [$type => 'dto']
+        );
+
+        $config = new ParamConverter([]);
+        $config->setName('dto');
+        $config->setClass($type);
+        $config->setIsOptional(false);
+        $config->setConverter('data_transfer_object_converter');
+        $config->setOptions([
+            'validate' => $context[self::VALIDATION_CONTEXT_KEY] ?? true
+        ]);
+
+        $this->paramConverterManager->apply($request, $config);
+
+        return $request->get('dto');
+    }
+
+    /**
+     * @param mixed  $data
+     * @param string $type
+     * @param null   $format
+     *
+     * @return bool|void
+     */
+    public function supportsDenormalization($data, $type, $format = null): bool
+    {
+        return is_array($data) && is_subclass_of($type, DataTransferObjectInterface::class);
+    }
+}