vendor/symfony/form/Extension/Core/DataAccessor/PropertyPathAccessor.php line 54

  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\DataAccessor;
  14. use Symfony\Component\Form\DataAccessorInterface;
  15. use Symfony\Component\Form\DataMapperInterface;
  16. use Symfony\Component\Form\Exception\AccessException;
  17. use Symfony\Component\Form\Extension\Core\DataMapper\DataMapper;
  18. use Symfony\Component\Form\FormInterface;
  19. use Symfony\Component\PropertyAccess\Exception\AccessException as PropertyAccessException;
  20. use Symfony\Component\PropertyAccess\Exception\NoSuchIndexException;
  21. use Symfony\Component\PropertyAccess\Exception\NoSuchPropertyException;
  22. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  23. use Symfony\Component\PropertyAccess\PropertyAccess;
  24. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  25. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  27. /**
  28.  * Writes and reads values to/from an object or array using property path.
  29.  *
  30.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  31.  * @author Bernhard Schussek <bschussek@gmail.com>
  32.  */
  33. class PropertyPathAccessor implements DataAccessorInterface
  34. {
  35.     private PropertyAccessorInterface $propertyAccessor;
  37.     public function __construct(?PropertyAccessorInterface $propertyAccessor = null)
  38.     {
  39.         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  40.     }
  42.     public function getValue(object|array $data, FormInterface $form): mixed
  43.     {
  44.         if (null === $propertyPath = $form->getPropertyPath()) {
  45.             throw new AccessException('Unable to read from the given form data as no property path is defined.');
  46.         }
  48.         return $this->getPropertyValue($data, $propertyPath);
  49.     }
  51.     public function setValue(object|array &$data, mixed $value, FormInterface $form): void
  52.     {
  53.         if (null === $propertyPath = $form->getPropertyPath()) {
  54.             throw new AccessException('Unable to write the given value as no property path is defined.');
  55.         }
  57.         $getValue = function () use ($data, $form, $propertyPath) {
  58.             $dataMapper = $this->getDataMapper($form);
  60.             if ($dataMapper instanceof DataMapper && null !== $dataAccessor = $dataMapper->getDataAccessor()) {
  61.                 return $dataAccessor->getValue($data, $form);
  62.             }
  64.             return $this->getPropertyValue($data, $propertyPath);
  65.         };
  67.         // If the field is of type DateTimeInterface and the data is the same skip the update to
  68.         // keep the original object hash
  69.         if ($value instanceof \DateTimeInterface && $value == $getValue()) {
  70.             return;
  71.         }
  73.         // If the data is identical to the value in $data, we are
  74.         // dealing with a reference
  75.         if (!\is_object($data) || !$form->getConfig()->getByReference() || $value !== $getValue()) {
  76.             try {
  77.                 $this->propertyAccessor->setValue($data, $propertyPath, $value);
  78.             } catch (NoSuchPropertyException $e) {
  79.                 throw new NoSuchPropertyException($e->getMessage().' Make the property public, add a setter, or set the "mapped" field option in the form type to be false.', 0, $e);
  80.             }
  81.         }
  82.     }
  84.     public function isReadable(object|array $data, FormInterface $form): bool
  85.     {
  86.         return null !== $form->getPropertyPath();
  87.     }
  89.     public function isWritable(object|array $data, FormInterface $form): bool
  90.     {
  91.         return null !== $form->getPropertyPath();
  92.     }
  94.     private function getPropertyValue(object|array $data, PropertyPathInterface $propertyPath): mixed
  95.     {
  96.         try {
  97.             return $this->propertyAccessor->getValue($data, $propertyPath);
  98.         } catch (PropertyAccessException $e) {
  99.             if (\is_array($data) && $e instanceof NoSuchIndexException) {
  100.                 return null;
  101.             }
  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.     }
  114.     private function getDataMapper(FormInterface $form): ?DataMapperInterface
  115.     {
  116.         do {
  117.             $dataMapper = $form->getConfig()->getDataMapper();
  118.         } while (null === $dataMapper && null !== $form = $form->getParent());
  120.         return $dataMapper;
  121.     }
  122. }