[Form] Add accessor data mapper for built-in DTO support

symfony · alcaeus · Jul 20, 2020 · Jul 20, 2020 · Jul 20, 2020 · Jul 20, 2020
commit 7ca2f0b753a5f8372dfc7c669dfd439617602030
diff --git a/src/Symfony/Component/Form/Extension/Core/CoreExtension.php b/src/Symfony/Component/Form/Extension/Core/CoreExtension.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Form\ChoiceList\Factory\ChoiceListFactoryInterface;
 use Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory;
 use Symfony\Component\Form\ChoiceList\Factory\PropertyAccessDecorator;
+use Symfony\Component\Form\Extension\Core\Type\AccessorMapperExtension;
 use Symfony\Component\Form\Extension\Core\Type\TransformationFailureExtension;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@@ -84,6 +85,7 @@ protected function loadTypeExtensions()
     {
         return [
             new TransformationFailureExtension($this->translator),
+            new AccessorMapperExtension(),
         ];
     }
 }
diff --git a/src/Symfony/Component/Form/Extension/Core/DataMapper/AccessorMapper.php b/src/Symfony/Component/Form/Extension/Core/DataMapper/AccessorMapper.php
@@ -0,0 +1,81 @@
+<?php
+
+namespace Symfony\Component\Form\Extension\Core\DataMapper;
+
+use Symfony\Component\Form\DataMapperInterface;
+use Symfony\Component\Form\Exception\UnexpectedTypeException;
+
+class AccessorMapper implements DataMapperInterface
+{
+    private $get;
+    private $set;
+    private $fallbackMapper;
+
+    public function __construct(?\Closure $get, ?\Closure $set, DataMapperInterface $fallbackMapper)
+    {
+        $this->get = $get;
+        $this->set = $set;
+        $this->fallbackMapper = $fallbackMapper;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function mapDataToForms($data, iterable $forms)
+    {
+        $empty = null === $data || [] === $data;
+
+        if (!$empty && !\is_array($data) && !\is_object($data)) {
+            throw new UnexpectedTypeException($data, 'object, array or empty');
+        }
+
+        if (!$this->get) {
+            $this->fallbackMapper->mapDataToForms($data, $forms);
+            return;
+        }
+
+        foreach ($forms as $form) {
+            $config = $form->getConfig();
+
+            if (!$empty && $config->getMapped()) {
+                $form->setData($this->getPropertyValue($data));
+            } else {
+                $form->setData($config->getData());
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function mapFormsToData(iterable $forms, &$data)
+    {
+        if (null === $data) {
+            return;
+        }
+
+        if (!\is_array($data) && !\is_object($data)) {
+            throw new UnexpectedTypeException($data, 'object, array or empty');
+        }
+
+        if (!$this->set) {
+            $this->fallbackMapper->mapFormsToData($forms, $data);
+            return;
+        }
+
+        foreach ($forms as $form) {
+            $config = $form->getConfig();
+
+            // Write-back is disabled if the form is not synchronized (transformation failed),
+            // if the form was not submitted and if the form is disabled (modification not allowed)
+            if (null !== $this->set && $config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled()) {
+                ($this->set)($data, $form->getData());
+            }
+        }
+    }
+
+    private function getPropertyValue($data)
+    {
+        return $this->get ? ($this->get)($data) : null;
+    }
+}
diff --git a/src/Symfony/Component/Form/Extension/Core/Type/AccessorMapperExtension.php b/src/Symfony/Component/Form/Extension/Core/Type/AccessorMapperExtension.php
@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Form\Extension\Core\Type;
+
+use Closure;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\DataMapper\AccessorMapper;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class AccessorMapperExtension extends AbstractTypeExtension
+{
+    public function buildForm(FormBuilderInterface $builder, array $options)
+    {
+        if (!$options['get'] && !$options['set']) {
+            return;
+        }
+
+        if (!$dataMapper = $builder->getDataMapper()) {
+            return;
+        }
+
+        $builder->setDataMapper(new AccessorMapper($options['get'], $options['set'], $dataMapper));
+    }
+
+    public function configureOptions(OptionsResolver $resolver)
+    {
+        $resolver->setDefaults([
+            'get' => null,
+            'set' => null,
+        ]);
+
+        $resolver->setAllowedTypes('get', ['null', Closure::class]);
+        $resolver->setAllowedTypes('set', ['null', Closure::class]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getExtendedTypes(): iterable
+    {
+        return [FormType::class];
+    }
+}
diff --git a/src/Symfony/Component/Form/Tests/Extension/Core/CoreExtensionTest.php b/src/Symfony/Component/Form/Tests/Extension/Core/CoreExtensionTest.php
@@ -11,8 +11,12 @@
 
 namespace Symfony\Component\Form\Tests\Extension\Core;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use stdClass;
 use Symfony\Component\Form\Extension\Core\CoreExtension;
+use Symfony\Component\Form\Extension\Core\DataMapper\AccessorMapper;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\FormFactoryBuilder;
 
 class CoreExtensionTest extends TestCase
@@ -30,4 +34,32 @@ public function testTransformationFailuresAreConvertedIntoFormErrors()
 
         $this->assertFalse($form->isValid());
     }
+
+    public function testMapperExtensionIsLoaded()
+    {
+        $formFactoryBuilder = new FormFactoryBuilder();
+        $formFactory = $formFactoryBuilder->addExtension(new CoreExtension())
+            ->getFormFactory();
+
+        $mock = $this->getMockBuilder(stdClass::class)->addMethods(['get', 'set'])->getMock();
+        $mock->expects($this->once())->method('get')->willReturn('foo');
+        $mock->expects($this->once())->method('set')->with('bar');
+
+        $formBuilder = $formFactory->createBuilder();
+        $form = $formBuilder
+            ->add(
+                'foo',
+                TextType::class
+            )
+            ->setDataMapper(new AccessorMapper(
+                function (MockObject $data) { return $data->get(); },
+                function (MockObject $data, $value) { return $data->set($value); },
+                $formBuilder->getDataMapper()
+            ))
+            ->setData($mock)
+            ->getForm();
+
+        $this->assertInstanceOf(AccessorMapper::class, $form->getConfig()->getDataMapper());
+        $form->submit(['foo' => 'bar']);
+    }
 }