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

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