vendor/symfony/form/Extension/Core/DataMapper/PropertyPathMapper.php line 61

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Form\Extension\Core\DataMapper;
  14. use Symfony\Component\Form\DataMapperInterface;
  15. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  16. use Symfony\Component\PropertyAccess\Exception\AccessException;
  17. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  18. use Symfony\Component\PropertyAccess\PropertyAccess;
  19. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  21. /**
  22.  * Maps arrays/objects to/from forms using property paths.
  23.  *
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  */
  26. class PropertyPathMapper implements DataMapperInterface
  27. {
  28.     private $propertyAccessor;
  30.     public function __construct(PropertyAccessorInterface $propertyAccessor = null)
  31.     {
  32.         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  33.     }
  35.     /**
  36.      * {@inheritdoc}
  37.      */
  38.     public function mapDataToForms($data, $forms)
  39.     {
  40.         $empty = null === $data || [] === $data;
  42.         if (!$empty && !\is_array($data) && !\is_object($data)) {
  43.             throw new UnexpectedTypeException($data, 'object, array or empty');
  44.         }
  46.         foreach ($forms as $form) {
  47.             $propertyPath = $form->getPropertyPath();
  48.             $config = $form->getConfig();
  50.             if (!$empty && null !== $propertyPath && $config->getMapped()) {
  51.                 $form->setData($this->getPropertyValue($data, $propertyPath));
  52.             } else {
  53.                 $form->setData($config->getData());
  54.             }
  55.         }
  56.     }
  58.     /**
  59.      * {@inheritdoc}
  60.      */
  61.     public function mapFormsToData($forms, &$data)
  62.     {
  63.         if (null === $data) {
  64.             return;
  65.         }
  67.         if (!\is_array($data) && !\is_object($data)) {
  68.             throw new UnexpectedTypeException($data, 'object, array or empty');
  69.         }
  71.         foreach ($forms as $form) {
  72.             $propertyPath = $form->getPropertyPath();
  73.             $config = $form->getConfig();
  75.             // Write-back is disabled if the form is not synchronized (transformation failed),
  76.             // if the form was not submitted and if the form is disabled (modification not allowed)
  77.             if (null !== $propertyPath && $config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled()) {
  78.                 $propertyValue = $form->getData();
  79.                 // If the field is of type DateTimeInterface and the data is the same skip the update to
  80.                 // keep the original object hash
  81.                 if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->getPropertyValue($data, $propertyPath)) {
  82.                     continue;
  83.                 }
  85.                 // If the data is identical to the value in $data, we are
  86.                 // dealing with a reference
  87.                 if (!\is_object($data) || !$config->getByReference() || $propertyValue !== $this->getPropertyValue($data, $propertyPath)) {
  88.                     $this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
  89.                 }
  90.             }
  91.         }
  92.     }
  94.     private function getPropertyValue($data, $propertyPath)
  95.     {
  96.         try {
  97.             return $this->propertyAccessor->getValue($data, $propertyPath);
  98.         } catch (AccessException $e) {
  99.             if (!$e instanceof UninitializedPropertyException
  100.                 // For versions without UninitializedPropertyException check the exception message
  101.                 && (class_exists(UninitializedPropertyException::class) || !str_contains($e->getMessage(), 'You should initialize it'))
  102.             ) {
  103.                 throw $e;
  104.             }
  106.             return null;
  107.         }
  108.     }
  109. }