symfony · fabpot · Sep 16, 2020 · Aug 27, 2020
diff --git a/UPGRADE-5.2.md b/UPGRADE-5.2.md
@@ -16,6 +16,28 @@ FrameworkBundle
    used to be added by default to the seed, which is not the case anymore. This allows sharing caches between
    apps or different environments.
 
+Form
+----
+
+ * Deprecated `PropertyPathMapper` in favor of `DataMapper` and `PropertyPathAccessor`.
+
+ Before:
+
+ ```php
+ use Symfony\Component\Form\Extension\Core\DataMapper\PropertyPathMapper;
+
+ $builder->setDataMapper(new PropertyPathMapper());
+ ```
+
+ After:
+
+ ```php
+ use Symfony\Component\Form\Extension\Core\DataAccessor\PropertyPathAccessor;
+ use Symfony\Component\Form\Extension\Core\DataMapper\DataMapper;
+
+ $builder->setDataMapper(new DataMapper(new PropertyPathAccessor()));
+ ```
+
 Lock
 ----
 

diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -48,6 +48,7 @@ Form
  * Added argument `callable|null $filter` to `ChoiceListFactoryInterface::createListFromChoices()` and `createListFromLoader()`.
  * The `Symfony\Component\Form\Extension\Validator\Util\ServerParams` class has been removed, use its parent `Symfony\Component\Form\Util\ServerParams` instead.
  * The `NumberToLocalizedStringTransformer::ROUND_*` constants have been removed, use `\NumberFormatter::ROUND_*` instead.
+ * Removed `PropertyPathMapper` in favor of `DataMapper` and `PropertyPathAccessor`.
 
 FrameworkBundle
 ---------------

diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -5,6 +5,8 @@ CHANGELOG
 -----
 
  * Added support for using the `{{ label }}` placeholder in constraint messages, which is replaced in the `ViolationMapper` by the corresponding field form label.
+ * Added `DataMapper`, `ChainAccessor`, `PropertyPathAccessor` and `CallbackAccessor` with new callable `getter` and `setter` options for each form type
+ * Deprecated `PropertyPathMapper` in favor of `DataMapper` and `PropertyPathAccessor`
 
 5.1.0
 -----

diff --git a/src/Symfony/Component/Form/DataAccessorInterface.php b/src/Symfony/Component/Form/DataAccessorInterface.php
@@ -0,0 +1,69 @@
+<?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;
+
+/**
+ * Writes and reads values to/from an object or array bound to a form.
+ *
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+interface DataAccessorInterface
+{
+    /**
+     * Returns the value at the end of the property of the object graph.
+     *
+     * @param object|array  $viewData The view data of the compound form
+     * @param FormInterface $form     The {@link FormInterface()} instance to check
+     *
+     * @return mixed The value at the end of the property
+     *
+     * @throws Exception\AccessException If unable to read from the given form data
+     */
+    public function getValue($viewData, FormInterface $form);
+
+    /**
+     * Sets the value at the end of the property of the object graph.
+     *
+     * @param object|array  $viewData The view data of the compound form
+     * @param mixed         $value    The value to set at the end of the object graph
+     * @param FormInterface $form     The {@link FormInterface()} instance to check
+     *
+     * @throws Exception\AccessException If unable to write the given value
+     */
+    public function setValue(&$viewData, $value, FormInterface $form): void;
+
+    /**
+     * Returns whether a value can be read from an object graph.
+     *
+     * Whenever this method returns true, {@link getValue()} is guaranteed not
+     * to throw an exception when called with the same arguments.
+     *
+     * @param object|array  $viewData The view data of the compound form
+     * @param FormInterface $form     The {@link FormInterface()} instance to check
+     *
+     * @return bool Whether the value can be read
+     */
+    public function isReadable($viewData, FormInterface $form): bool;
+
+    /**
+     * Returns whether a value can be written at a given object graph.
+     *
+     * Whenever this method returns true, {@link setValue()} is guaranteed not
+     * to throw an exception when called with the same arguments.
+     *
+     * @param object|array  $viewData The view data of the compound form
+     * @param FormInterface $form     The {@link FormInterface()} instance to check
+     *
+     * @return bool Whether the value can be set
+     */
+    public function isWritable($viewData, FormInterface $form): bool;
+}
diff --git a/src/Symfony/Component/Form/Exception/AccessException.php b/src/Symfony/Component/Form/Exception/AccessException.php
@@ -0,0 +1,16 @@
+<?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\Exception;
+
+class AccessException extends RuntimeException
+{
+}
diff --git a/src/Symfony/Component/Form/Extension/Core/DataAccessor/CallbackAccessor.php b/src/Symfony/Component/Form/Extension/Core/DataAccessor/CallbackAccessor.php
@@ -0,0 +1,64 @@
+<?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\DataAccessor;
+
+use Symfony\Component\Form\DataAccessorInterface;
+use Symfony\Component\Form\Exception\AccessException;
+use Symfony\Component\Form\FormInterface;
+
+/**
+ * Writes and reads values to/from an object or array using callback functions.
+ *
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+class CallbackAccessor implements DataAccessorInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getValue($data, FormInterface $form)
+    {
+        if (null === $getter = $form->getConfig()->getOption('getter')) {
+            throw new AccessException('Unable to read from the given form data as no getter is defined.');
+        }
+
+        return ($getter)($data, $form);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setValue(&$data, $value, FormInterface $form): void
+    {
+        if (null === $setter = $form->getConfig()->getOption('setter')) {
+            throw new AccessException('Unable to write the given value as no setter is defined.');
+        }
+
+        ($setter)($data, $form->getData(), $form);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isReadable($data, FormInterface $form): bool
+    {
+        return null !== $form->getConfig()->getOption('getter');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable($data, FormInterface $form): bool
+    {
+        return null !== $form->getConfig()->getOption('setter');
+    }
+}
diff --git a/src/Symfony/Component/Form/Extension/Core/DataAccessor/ChainAccessor.php b/src/Symfony/Component/Form/Extension/Core/DataAccessor/ChainAccessor.php
@@ -0,0 +1,90 @@
+<?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\DataAccessor;
+
+use Symfony\Component\Form\DataAccessorInterface;
+use Symfony\Component\Form\Exception\AccessException;
+use Symfony\Component\Form\FormInterface;
+
+/**
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ */
+class ChainAccessor implements DataAccessorInterface
+{
+    private $accessors;
+
+    /**
+     * @param DataAccessorInterface[]|iterable $accessors
+     */
+    public function __construct(iterable $accessors)
+    {
+        $this->accessors = $accessors;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getValue($data, FormInterface $form)
+    {
+        foreach ($this->accessors as $accessor) {
+            if ($accessor->isReadable($data, $form)) {
+                return $accessor->getValue($data, $form);
+            }
+        }
+
+        throw new AccessException('Unable to read from the given form data as no accessor in the chain is able to read the data.');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setValue(&$data, $value, FormInterface $form): void
+    {
+        foreach ($this->accessors as $accessor) {
+            if ($accessor->isWritable($data, $form)) {
+                $accessor->setValue($data, $value, $form);
+
+                return;
+            }
+        }
+
+        throw new AccessException('Unable to write the given value as no accessor in the chain is able to set the data.');
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isReadable($data, FormInterface $form): bool
+    {
+        foreach ($this->accessors as $accessor) {
+            if ($accessor->isReadable($data, $form)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable($data, FormInterface $form): bool
+    {
+        foreach ($this->accessors as $accessor) {
+            if ($accessor->isWritable($data, $form)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}
diff --git a/src/Symfony/Component/Form/Extension/Core/DataAccessor/PropertyPathAccessor.php b/src/Symfony/Component/Form/Extension/Core/DataAccessor/PropertyPathAccessor.php
@@ -0,0 +1,102 @@
+<?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\DataAccessor;
+
+use Symfony\Component\Form\DataAccessorInterface;
+use Symfony\Component\Form\Exception\AccessException;
+use Symfony\Component\Form\FormInterface;
+use Symfony\Component\PropertyAccess\Exception\AccessException as PropertyAccessException;
+use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
+use Symfony\Component\PropertyAccess\PropertyAccess;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+
+/**
+ * Writes and reads values to/from an object or array using property path.
+ *
+ * @author Yonel Ceruto <yonelceruto@gmail.com>
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+class PropertyPathAccessor implements DataAccessorInterface
+{
+    private $propertyAccessor;
+
+    public function __construct(PropertyAccessorInterface $propertyAccessor = null)
+    {
+        $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getValue($data, FormInterface $form)
+    {
+        if (null === $propertyPath = $form->getPropertyPath()) {
+            throw new AccessException('Unable to read from the given form data as no property path is defined.');
+        }
+
+        return $this->getPropertyValue($data, $propertyPath);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setValue(&$data, $propertyValue, FormInterface $form): void
+    {
+        if (null === $propertyPath = $form->getPropertyPath()) {
+            throw new AccessException('Unable to write the given value as no property path is defined.');
+        }
+
+        // If the field is of type DateTimeInterface and the data is the same skip the update to
+        // keep the original object hash
+        if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->getPropertyValue($data, $propertyPath)) {
+            return;
+        }
+
+        // If the data is identical to the value in $data, we are
+        // dealing with a reference
+        if (!\is_object($data) || !$form->getConfig()->getByReference() || $propertyValue !== $this->getPropertyValue($data, $propertyPath)) {
+            $this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isReadable($data, FormInterface $form): bool
+    {
+        return null !== $form->getPropertyPath();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isWritable($data, FormInterface $form): bool
+    {
+        return null !== $form->getPropertyPath();
+    }
+
+    private function getPropertyValue($data, $propertyPath)
+    {
+        try {
+            return $this->propertyAccessor->getValue($data, $propertyPath);
+        } catch (PropertyAccessException $e) {
+            if (!$e instanceof UninitializedPropertyException
+                // For versions without UninitializedPropertyException check the exception message
+                && (class_exists(UninitializedPropertyException::class) || false === strpos($e->getMessage(), 'You should initialize it'))
+            ) {
+                throw $e;
+            }
+
+            return null;
+        }
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,8 @@ CHANGELOG @@
     -----
      * Added support for using the `{{ label }}` placeholder in constraint messages, which is replaced in the `ViolationMapper` by the corresponding field form label.
+     * Added `DataMapper`, `ChainAccessor`, `PropertyPathAccessor` and `CallbackAccessor` with new callable `getter` and `setter` options for each form type
+     * Deprecated `PropertyPathMapper` in favor of `DataMapper` and `PropertyPathAccessor`
 .1.0
     -----
@@ Expand Down @@