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

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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\UninitializedPropertyException;
  22. use Symfony\Component\PropertyAccess\PropertyAccess;
  23. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  24. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  26. /**
  27. * Writes and reads values to/from an object or array using property path.
  28. *
  29. * @author Yonel Ceruto <[email protected]>
  30. * @author Bernhard Schussek <[email protected]>
  31. */
  32. class PropertyPathAccessor implements DataAccessorInterface
  33. {
  34. private $propertyAccessor;
  36. public function __construct(?PropertyAccessorInterface $propertyAccessor = null)
  37. {
  38. $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
  39. }
  41. /**
  42. * {@inheritdoc}
  43. */
  44. public function getValue($data, FormInterface $form)
  45. {
  46. if (null === $propertyPath = $form->getPropertyPath()) {
  47. throw new AccessException('Unable to read from the given form data as no property path is defined.');
  48. }
  50. return $this->getPropertyValue($data, $propertyPath);
  51. }
  53. /**
  54. * {@inheritdoc}
  55. */
  56. public function setValue(&$data, $propertyValue, FormInterface $form): void
  57. {
  58. if (null === $propertyPath = $form->getPropertyPath()) {
  59. throw new AccessException('Unable to write the given value as no property path is defined.');
  60. }
  62. $getValue = function () use ($data, $form, $propertyPath) {
  63. $dataMapper = $this->getDataMapper($form);
  65. if ($dataMapper instanceof DataMapper && null !== $dataAccessor = $dataMapper->getDataAccessor()) {
  66. return $dataAccessor->getValue($data, $form);
  67. }
  69. return $this->getPropertyValue($data, $propertyPath);
  70. };
  72. // If the field is of type DateTimeInterface and the data is the same skip the update to
  73. // keep the original object hash
  74. if ($propertyValue instanceof \DateTimeInterface && $propertyValue == $getValue()) {
  75. return;
  76. }
  78. // If the data is identical to the value in $data, we are
  79. // dealing with a reference
  80. if (!\is_object($data) || !$form->getConfig()->getByReference() || $propertyValue !== $getValue()) {
  81. $this->propertyAccessor->setValue($data, $propertyPath, $propertyValue);
  82. }
  83. }
  85. /**
  86. * {@inheritdoc}
  87. */
  88. public function isReadable($data, FormInterface $form): bool
  89. {
  90. return null !== $form->getPropertyPath();
  91. }
  93. /**
  94. * {@inheritdoc}
  95. */
  96. public function isWritable($data, FormInterface $form): bool
  97. {
  98. return null !== $form->getPropertyPath();
  99. }
  101. private function getPropertyValue($data, PropertyPathInterface $propertyPath)
  102. {
  103. try {
  104. return $this->propertyAccessor->getValue($data, $propertyPath);
  105. } catch (PropertyAccessException $e) {
  106. if (\is_array($data) && $e instanceof NoSuchIndexException) {
  107. return null;
  108. }
  110. if (!$e instanceof UninitializedPropertyException
  111. // For versions without UninitializedPropertyException check the exception message
  112. && (class_exists(UninitializedPropertyException::class) || false === strpos($e->getMessage(), 'You should initialize it'))
  113. ) {
  114. throw $e;
  115. }
  117. return null;
  118. }
  119. }
  121. private function getDataMapper(FormInterface $form): ?DataMapperInterface
  122. {
  123. do {
  124. $dataMapper = $form->getConfig()->getDataMapper();
  125. } while (null === $dataMapper && null !== $form = $form->getParent());
  127. return $dataMapper;
  128. }
  129. }