vendor/symfony/form/Extension/Core/DataMapper/DataMapper.php line 59

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\DataAccessorInterface;
  15. use Symfony\Component\Form\DataMapperInterface;
  16. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  17. use Symfony\Component\Form\Extension\Core\DataAccessor\CallbackAccessor;
  18. use Symfony\Component\Form\Extension\Core\DataAccessor\ChainAccessor;
  19. use Symfony\Component\Form\Extension\Core\DataAccessor\PropertyPathAccessor;
  21. /**
  22.  * Maps arrays/objects to/from forms using data accessors.
  23.  *
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  */
  26. class DataMapper implements DataMapperInterface
  27. {
  28.     private $dataAccessor;
  30.     public function __construct(?DataAccessorInterface $dataAccessor = null)
  31.     {
  32.         $this->dataAccessor = $dataAccessor ?? new ChainAccessor([
  33.             new CallbackAccessor(),
  34.             new PropertyPathAccessor(),
  35.         ]);
  36.     }
  38.     /**
  39.      * {@inheritdoc}
  40.      */
  41.     public function mapDataToForms($data, iterable $forms): void
  42.     {
  43.         if (\is_array($forms)) {
  44.             trigger_deprecation('symfony/form', '5.3', 'Passing an array as the second argument of the "%s()" method is deprecated, pass "\Traversable" instead.', __METHOD__);
  45.         }
  47.         $empty = null === $data || [] === $data;
  49.         if (!$empty && !\is_array($data) && !\is_object($data)) {
  50.             throw new UnexpectedTypeException($data, 'object, array or empty');
  51.         }
  53.         foreach ($forms as $form) {
  54.             $config = $form->getConfig();
  56.             if (!$empty && $config->getMapped() && $this->dataAccessor->isReadable($data, $form)) {
  57.                 $form->setData($this->dataAccessor->getValue($data, $form));
  58.             } else {
  59.                 $form->setData($config->getData());
  60.             }
  61.         }
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      */
  67.     public function mapFormsToData(iterable $forms, &$data): void
  68.     {
  69.         if (\is_array($forms)) {
  70.             trigger_deprecation('symfony/form', '5.3', 'Passing an array as the first argument of the "%s()" method is deprecated, pass "\Traversable" instead.', __METHOD__);
  71.         }
  73.         if (null === $data) {
  74.             return;
  75.         }
  77.         if (!\is_array($data) && !\is_object($data)) {
  78.             throw new UnexpectedTypeException($data, 'object, array or empty');
  79.         }
  81.         foreach ($forms as $form) {
  82.             $config = $form->getConfig();
  84.             // Write-back is disabled if the form is not synchronized (transformation failed),
  85.             // if the form was not submitted and if the form is disabled (modification not allowed)
  86.             if ($config->getMapped() && $form->isSubmitted() && $form->isSynchronized() && !$form->isDisabled() && $this->dataAccessor->isWritable($data, $form)) {
  87.                 $this->dataAccessor->setValue($data, $form->getData(), $form);
  88.             }
  89.         }
  90.     }
  92.     /**
  93.      * @internal
  94.      */
  95.     public function getDataAccessor(): DataAccessorInterface
  96.     {
  97.         return $this->dataAccessor;
  98.     }
  99. }