vendor/symfony/form/Extension/DataCollector/FormDataCollector.php line 266

  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\DataCollector;
  14. use Symfony\Component\Form\FormInterface;
  15. use Symfony\Component\Form\FormView;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\DataCollector\DataCollector;
  19. use Symfony\Component\Validator\ConstraintViolationInterface;
  20. use Symfony\Component\VarDumper\Caster\Caster;
  21. use Symfony\Component\VarDumper\Caster\ClassStub;
  22. use Symfony\Component\VarDumper\Caster\StubCaster;
  23. use Symfony\Component\VarDumper\Cloner\Data;
  24. use Symfony\Component\VarDumper\Cloner\Stub;
  26. /**
  27.  * Data collector for {@link FormInterface} instances.
  28.  *
  29.  * @author Robert Schönthal <robert.schoenthal@gmail.com>
  30.  * @author Bernhard Schussek <bschussek@gmail.com>
  31.  *
  32.  * @final
  33.  */
  34. class FormDataCollector extends DataCollector implements FormDataCollectorInterface
  35. {
  36.     private FormDataExtractorInterface $dataExtractor;
  38.     /**
  39.      * Stores the collected data per {@link FormInterface} instance.
  40.      *
  41.      * Uses the hashes of the forms as keys. This is preferable over using
  42.      * {@link \SplObjectStorage}, because in this way no references are kept
  43.      * to the {@link FormInterface} instances.
  44.      */
  45.     private array $dataByForm;
  47.     /**
  48.      * Stores the collected data per {@link FormView} instance.
  49.      *
  50.      * Uses the hashes of the views as keys. This is preferable over using
  51.      * {@link \SplObjectStorage}, because in this way no references are kept
  52.      * to the {@link FormView} instances.
  53.      */
  54.     private array $dataByView;
  56.     /**
  57.      * Connects {@link FormView} with {@link FormInterface} instances.
  58.      *
  59.      * Uses the hashes of the views as keys and the hashes of the forms as
  60.      * values. This is preferable over storing the objects directly, because
  61.      * this way they can safely be discarded by the GC.
  62.      */
  63.     private array $formsByView;
  65.     public function __construct(FormDataExtractorInterface $dataExtractor)
  66.     {
  67.         if (!class_exists(ClassStub::class)) {
  68.             throw new \LogicException(sprintf('The VarDumper component is needed for using the "%s" class. Install symfony/var-dumper version 3.4 or above.', __CLASS__));
  69.         }
  71.         $this->dataExtractor = $dataExtractor;
  73.         $this->reset();
  74.     }
  76.     /**
  77.      * Does nothing. The data is collected during the form event listeners.
  78.      */
  79.     public function collect(Request $request, Response $response, \Throwable $exception = null)
  80.     {
  81.     }
  83.     public function reset()
  84.     {
  85.         $this->data = [
  86.             'forms' => [],
  87.             'forms_by_hash' => [],
  88.             'nb_errors' => 0,
  89.         ];
  90.     }
  92.     public function associateFormWithView(FormInterface $form, FormView $view)
  93.     {
  94.         $this->formsByView[spl_object_hash($view)] = spl_object_hash($form);
  95.     }
  97.     public function collectConfiguration(FormInterface $form)
  98.     {
  99.         $hash = spl_object_hash($form);
  101.         if (!isset($this->dataByForm[$hash])) {
  102.             $this->dataByForm[$hash] = [];
  103.         }
  105.         $this->dataByForm[$hash] = array_replace(
  106.             $this->dataByForm[$hash],
  107.             $this->dataExtractor->extractConfiguration($form)
  108.         );
  110.         foreach ($form as $child) {
  111.             $this->collectConfiguration($child);
  112.         }
  113.     }
  115.     public function collectDefaultData(FormInterface $form)
  116.     {
  117.         $hash = spl_object_hash($form);
  119.         if (!isset($this->dataByForm[$hash])) {
  120.             // field was created by form event
  121.             $this->collectConfiguration($form);
  122.         }
  124.         $this->dataByForm[$hash] = array_replace(
  125.             $this->dataByForm[$hash],
  126.             $this->dataExtractor->extractDefaultData($form)
  127.         );
  129.         foreach ($form as $child) {
  130.             $this->collectDefaultData($child);
  131.         }
  132.     }
  134.     public function collectSubmittedData(FormInterface $form)
  135.     {
  136.         $hash = spl_object_hash($form);
  138.         if (!isset($this->dataByForm[$hash])) {
  139.             // field was created by form event
  140.             $this->collectConfiguration($form);
  141.             $this->collectDefaultData($form);
  142.         }
  144.         $this->dataByForm[$hash] = array_replace(
  145.             $this->dataByForm[$hash],
  146.             $this->dataExtractor->extractSubmittedData($form)
  147.         );
  149.         // Count errors
  150.         if (isset($this->dataByForm[$hash]['errors'])) {
  151.             $this->data['nb_errors'] += \count($this->dataByForm[$hash]['errors']);
  152.         }
  154.         foreach ($form as $child) {
  155.             $this->collectSubmittedData($child);
  157.             // Expand current form if there are children with errors
  158.             if (empty($this->dataByForm[$hash]['has_children_error'])) {
  159.                 $childData = $this->dataByForm[spl_object_hash($child)];
  160.                 $this->dataByForm[$hash]['has_children_error'] = !empty($childData['has_children_error']) || !empty($childData['errors']);
  161.             }
  162.         }
  163.     }
  165.     public function collectViewVariables(FormView $view)
  166.     {
  167.         $hash = spl_object_hash($view);
  169.         if (!isset($this->dataByView[$hash])) {
  170.             $this->dataByView[$hash] = [];
  171.         }
  173.         $this->dataByView[$hash] = array_replace(
  174.             $this->dataByView[$hash],
  175.             $this->dataExtractor->extractViewVariables($view)
  176.         );
  178.         foreach ($view->children as $child) {
  179.             $this->collectViewVariables($child);
  180.         }
  181.     }
  183.     public function buildPreliminaryFormTree(FormInterface $form)
  184.     {
  185.         $this->data['forms'][$form->getName()] = &$this->recursiveBuildPreliminaryFormTree($form, $this->data['forms_by_hash']);
  186.     }
  188.     public function buildFinalFormTree(FormInterface $form, FormView $view)
  189.     {
  190.         $this->data['forms'][$form->getName()] = &$this->recursiveBuildFinalFormTree($form, $view, $this->data['forms_by_hash']);
  191.     }
  193.     public function getName(): string
  194.     {
  195.         return 'form';
  196.     }
  198.     public function getData(): array|Data
  199.     {
  200.         return $this->data;
  201.     }
  203.     /**
  204.      * @internal
  205.      */
  206.     public function __sleep(): array
  207.     {
  208.         foreach ($this->data['forms_by_hash'] as &$form) {
  209.             if (isset($form['type_class']) && !$form['type_class'] instanceof ClassStub) {
  210.                 $form['type_class'] = new ClassStub($form['type_class']);
  211.             }
  212.         }
  214.         $this->data = $this->cloneVar($this->data);
  216.         return parent::__sleep();
  217.     }
  219.     protected function getCasters(): array
  220.     {
  221.         return parent::getCasters() + [
  222.             \Exception::class => function (\Exception $e, array $a, Stub $s) {
  223.                 foreach (["\0Exception\0previous", "\0Exception\0trace"] as $k) {
  224.                     if (isset($a[$k])) {
  225.                         unset($a[$k]);
  226.                         ++$s->cut;
  227.                     }
  228.                 }
  230.                 return $a;
  231.             },
  232.             FormInterface::class => function (FormInterface $f, array $a) {
  233.                 return [
  234.                     Caster::PREFIX_VIRTUAL.'name' => $f->getName(),
  235.                     Caster::PREFIX_VIRTUAL.'type_class' => new ClassStub(\get_class($f->getConfig()->getType()->getInnerType())),
  236.                 ];
  237.             },
  238.             FormView::class => StubCaster::cutInternals(...),
  239.             ConstraintViolationInterface::class => function (ConstraintViolationInterface $v, array $a) {
  240.                 return [
  241.                     Caster::PREFIX_VIRTUAL.'root' => $v->getRoot(),
  242.                     Caster::PREFIX_VIRTUAL.'path' => $v->getPropertyPath(),
  243.                     Caster::PREFIX_VIRTUAL.'value' => $v->getInvalidValue(),
  244.                 ];
  245.             },
  246.         ];
  247.     }
  249.     private function &recursiveBuildPreliminaryFormTree(FormInterface $form, array &$outputByHash)
  250.     {
  251.         $hash = spl_object_hash($form);
  253.         $output = &$outputByHash[$hash];
  254.         $output = $this->dataByForm[$hash]
  255.             ?? [];
  257.         $output['children'] = [];
  259.         foreach ($form as $name => $child) {
  260.             $output['children'][$name] = &$this->recursiveBuildPreliminaryFormTree($child, $outputByHash);
  261.         }
  263.         return $output;
  264.     }
  266.     private function &recursiveBuildFinalFormTree(FormInterface $form = null, FormView $view, array &$outputByHash)
  267.     {
  268.         $viewHash = spl_object_hash($view);
  269.         $formHash = null;
  271.         if (null !== $form) {
  272.             $formHash = spl_object_hash($form);
  273.         } elseif (isset($this->formsByView[$viewHash])) {
  274.             // The FormInterface instance of the CSRF token is never contained in
  275.             // the FormInterface tree of the form, so we need to get the
  276.             // corresponding FormInterface instance for its view in a different way
  277.             $formHash = $this->formsByView[$viewHash];
  278.         }
  279.         if (null !== $formHash) {
  280.             $output = &$outputByHash[$formHash];
  281.         }
  283.         $output = $this->dataByView[$viewHash]
  284.             ?? [];
  286.         if (null !== $formHash) {
  287.             $output = array_replace(
  288.                 $output,
  289.                 $this->dataByForm[$formHash]
  290.                     ?? []
  291.             );
  292.         }
  294.         $output['children'] = [];
  296.         foreach ($view->children as $name => $childView) {
  297.             // The CSRF token, for example, is never added to the form tree.
  298.             // It is only present in the view.
  299.             $childForm = $form?->has($name) ? $form->get($name) : null;
  301.             $output['children'][$name] = &$this->recursiveBuildFinalFormTree($childForm, $childView, $outputByHash);
  302.         }
  304.         return $output;
  305.     }
  306. }