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

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\NoSuchIndexException;
  18. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  19. use Symfony\Component\PropertyAccess\PropertyAccess;
  20. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  22. trigger_deprecation('symfony/form', '5.2', 'The "%s" class is deprecated. Use "%s" instead.', PropertyPathMapper::class, DataMapper::class);
  24. /**
  25.  * Maps arrays/objects to/from forms using property paths.
  26.  *
  27.  * @author Bernhard Schussek <bschussek@gmail.com>
  28.  *
  29.  * @deprecated since symfony/form 5.2. Use {@see DataMapper} instead.
  30.  */
  31. class PropertyPathMapper implements DataMapperInterface
  32. {
  33.     private $propertyAccessor;
  35.     public function __construct(?PropertyAccessorInterface $propertyAccessor = null)
  36.     {
  37.         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function mapDataToForms($data, iterable $forms)
  44.     {
  45.         $empty = null === $data || [] === $data;
  47.         if (!$empty && !\is_array($data) && !\is_object($data)) {
  48.             throw new UnexpectedTypeException($data, 'object, array or empty');
  49.         }
  51.         foreach ($forms as $form) {
  52.             $propertyPath = $form->getPropertyPath();
  53.             $config = $form->getConfig();
  55.             if (!$empty && null !== $propertyPath && $config->getMapped()) {
  56.                 $form->setData($this->getPropertyValue($data, $propertyPath));
  57.             } else {
  58.                 $form->setData($config->getData());
  59.             }
  60.         }
  61.     }
  63.     /**
  64.      * {@inheritdoc}
  65.      */
  66.     public function mapFormsToData(iterable $forms, &$data)
  67.     {
  68.         if (null === $data) {
  69.             return;
  70.         }
  72.         if (!\is_array($data) && !\is_object($data)) {
  73.             throw new UnexpectedTypeException($data, 'object, array or empty');
  74.         }
  76.         foreach ($forms as $form) {
  77.             $propertyPath = $form->getPropertyPath();
  78.             $config = $form->getConfig();
  80.             // Write-back is disabled if the form is not synchronized (transformation failed),
  81.             // if the form was not submitted and if the form is disabled (modification not allowed)
  82.             if (null !== $propertyPath && $config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled()) {
  83.                 $propertyValue = $form->getData();
  84.                 // If the field is of type DateTimeInterface and the data is the same skip the update to
  85.                 // keep the original object hash
  86.                 if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $this->getPropertyValue($data, $propertyPath)) {
  87.                     continue;
  88.                 }
  90.                 // If the data is identical to the value in $data, we are
  91.                 // dealing with a reference
  92.                 if (!\is_object($data) || !$config->getByReference() || $propertyValue !== $this->getPropertyValue($data, $propertyPath)) {
  93.                     $this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
  94.                 }
  95.             }
  96.         }
  97.     }
  99.     private function getPropertyValue($data, $propertyPath)
  100.     {
  101.         try {
  102.             return $this->propertyAccessor->getValue($data, $propertyPath);
  103.         } catch (AccessException $e) {
  104.             if (\is_array($data) && $e instanceof NoSuchIndexException) {
  105.                 return null;
  106.             }
  108.             if (!$e instanceof UninitializedPropertyException
  109.                 // For versions without UninitializedPropertyException check the exception message
  110.                 && (class_exists(UninitializedPropertyException::class) || !str_contains($e->getMessage(), 'You should initialize it'))
  111.             ) {
  112.                 throw $e;
  113.             }
  115.             return null;
  116.         }
  117.     }
  118. }