Merge pull request #22 from biig-io/feature/custom-data-mapper

Add new option custom data mapper on ApiType

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+- #22 Add possibility to define a custom data normalizer for ApiType 
+
 ## [0.3.2] - 2019-07-05
 ### Changed
 - #19 Documentation is now using scheme of the application

src/Bridge/Symfony/Form/DomainObjectDataMapperInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Biig\Melodiia\Bridge\Symfony\Form;
+
+use Symfony\Component\Form\DataMapperInterface;
+
+interface DomainObjectDataMapperInterface extends DataMapperInterface
+{
+    /**
+     * @param iterable    $form
+     * @param string|null $dataClass
+     *
+     * @return mixed
+     */
+    public function createObject(iterable $form, string $dataClass = null);
+}

src/Bridge/Symfony/Form/DomainObjectsDataMapper.php

@@ -9,7 +9,7 @@
 /**
  * Add support for objects that require constructor instantiation.
  */
-class DomainObjectsDataMapper extends PropertyPathMapper implements DataMapperInterface
+class DomainObjectsDataMapper extends PropertyPathMapper implements DomainObjectDataMapperInterface
 {
     public function mapFormsToData($forms, &$data)
     {
@@ -18,12 +18,7 @@ public function mapFormsToData($forms, &$data)
     }
 
     /**
-     * @param FormInterface[] $form
-     * @param string          $dataClass
-     *
-     * @throws \ReflectionException
-     *
-     * @return object|null
+     * {@inheritDoc}
      */
     public function createObject(iterable $form, string $dataClass = null)
     {

src/Bridge/Symfony/Form/Type/ApiType.php

@@ -21,6 +21,12 @@ public function __construct(DataMapperInterface $dataMapper = null)
 
     public function buildForm(FormBuilderInterface $builder, array $options)
     {
+        $dataMapper = $this->dataMapper;
+
+        if ($options['customDataMapper'] !== null) {
+            $dataMapper = $options['customDataMapper'];
+        }
+
         if ($options['value_object']) {
             $builder->setDataMapper($this->dataMapper);
         }
@@ -31,6 +37,7 @@ public function configureOptions(OptionsResolver $resolver)
         $resolver->setDefaults([
             'csrf_protection' => false,
             'value_object' => false,
+            'customDataMapper' => null,
 
             /*
              * Creates data object just like standard form would do
@@ -41,8 +48,15 @@ public function configureOptions(OptionsResolver $resolver)
              * @throws \ReflectionException
              */
             'empty_data' => function (FormInterface $form) {
-                return $this->dataMapper->createObject($form);
+                $dataMapper = $this->dataMapper;
+                if ($form->getConfig()->getOption('customDataMapper') !== null) {
+                    $dataMapper = $form->getConfig()->getOption('customDataMapper');
+                }
+
+                return $dataMapper->createObject($form);
             },
         ]);
+
+        $resolver->setAllowedTypes('customDataMapper', ['null', DomainObjectsDataMapper::class]);
     }
 }

tests/Melodiia/Bridge/Symfony/Form/ApiTypeTest.php

@@ -2,6 +2,7 @@
 
 namespace Biig\Melodiia\Test\Bridge\Symfony\Form;
 
+use Biig\Melodiia\Bridge\Symfony\Form\DomainObjectsDataMapper;
 use Biig\Melodiia\Bridge\Symfony\Form\Type\ApiType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\FormBuilderInterface;
@@ -34,6 +35,28 @@ public function testItReturnsDataForEmptyDataInCaseOfDataAvailable()
         $this->assertEquals('some content', $data->getFoo());
     }
 
+    public function testItSupportsCustomDataMapper()
+    {
+        $customDataMapper = new class extends DomainObjectsDataMapper {
+            private $hasBeenCalled = false;
+            public function createObject(iterable $form, string $dataClass = null)
+            {
+                $this->hasBeenCalled = true;
+                return parent::createObject($form, $dataClass);
+            }
+
+            public function hasBeenCalled() { return $this->hasBeenCalled; }
+        };
+        $form = $this->factory->createNamed('', FakeTypeUsingApiType::class, null, [
+            'customDataMapper' => $customDataMapper
+        ]);
+        $form->submit(['foo' => 'some content']);
+        $data = $form->getData();
+        $this->assertInstanceOf(FakeModel::class, $data);
+        $this->assertEquals('some content', $data->getFoo());
+        $this->assertTrue($customDataMapper->hasBeenCalled());
+    }
+
     protected function getTypes()
     {
         return [new ApiType()];