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

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\DataAccessor;
  14. use Symfony\Component\Form\DataAccessorInterface;
  15. use Symfony\Component\Form\Exception\AccessException;
  16. use Symfony\Component\Form\FormInterface;
  17. use Symfony\Component\PropertyAccess\Exception\AccessException as PropertyAccessException;
  18. use Symfony\Component\PropertyAccess\Exception\NoSuchIndexException;
  19. use Symfony\Component\PropertyAccess\Exception\UninitializedPropertyException;
  20. use Symfony\Component\PropertyAccess\PropertyAccess;
  21. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  22. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  24. /**
  25.  * Writes and reads values to/from an object or array using property path.
  26.  *
  27.  * @author Yonel Ceruto <yonelceruto@gmail.com>
  28.  * @author Bernhard Schussek <bschussek@gmail.com>
  29.  */
  30. class PropertyPathAccessor implements DataAccessorInterface
  31. {
  32.     private PropertyAccessorInterface $propertyAccessor;
  34.     public function __construct(PropertyAccessorInterface $propertyAccessor = null)
  35.     {
  36.         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  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.     /**
  52.      * {@inheritdoc}
  53.      */
  54.     public function setValue(object|array &$data, mixed $value, FormInterface $form): void
  55.     {
  56.         if (null === $propertyPath = $form->getPropertyPath()) {
  57.             throw new AccessException('Unable to write the given value as no property path is defined.');
  58.         }
  60.         // If the field is of type DateTimeInterface and the data is the same skip the update to
  61.         // keep the original object hash
  62.         if ($value instanceof \DateTimeInterface && $value == $this->getPropertyValue($data, $propertyPath)) {
  63.             return;
  64.         }
  66.         // If the data is identical to the value in $data, we are
  67.         // dealing with a reference
  68.         if (!\is_object($data) || !$form->getConfig()->getByReference() || $value !== $this->getPropertyValue($data, $propertyPath)) {
  69.             $this->propertyAccessor->setValue($data, $propertyPath, $value);
  70.         }
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function isReadable(object|array $data, FormInterface $form): bool
  77.     {
  78.         return null !== $form->getPropertyPath();
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function isWritable(object|array $data, FormInterface $form): bool
  85.     {
  86.         return null !== $form->getPropertyPath();
  87.     }
  89.     private function getPropertyValue(object|array $data, PropertyPathInterface $propertyPath)
  90.     {
  91.         try {
  92.             return $this->propertyAccessor->getValue($data, $propertyPath);
  93.         } catch (PropertyAccessException $e) {
  94.             if (\is_array($data) && $e instanceof NoSuchIndexException) {
  95.                 return null;
  96.             }
  98.             if (!$e instanceof UninitializedPropertyException
  99.                 // For versions without UninitializedPropertyException check the exception message
  100.                 && (class_exists(UninitializedPropertyException::class) || !str_contains($e->getMessage(), 'You should initialize it'))
  101.             ) {
  102.                 throw $e;
  103.             }
  105.             return null;
  106.         }
  107.     }
  108. }