vendor/symfony/form/Form.php line 493

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;
  14. use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
  15. use Symfony\Component\Form\Event\PostSetDataEvent;
  16. use Symfony\Component\Form\Event\PostSubmitEvent;
  17. use Symfony\Component\Form\Event\PreSetDataEvent;
  18. use Symfony\Component\Form\Event\PreSubmitEvent;
  19. use Symfony\Component\Form\Event\SubmitEvent;
  20. use Symfony\Component\Form\Exception\AlreadySubmittedException;
  21. use Symfony\Component\Form\Exception\LogicException;
  22. use Symfony\Component\Form\Exception\OutOfBoundsException;
  23. use Symfony\Component\Form\Exception\RuntimeException;
  24. use Symfony\Component\Form\Exception\TransformationFailedException;
  25. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  26. use Symfony\Component\Form\Util\FormUtil;
  27. use Symfony\Component\Form\Util\InheritDataAwareIterator;
  28. use Symfony\Component\Form\Util\OrderedHashMap;
  29. use Symfony\Component\PropertyAccess\PropertyPath;
  30. use Symfony\Component\PropertyAccess\PropertyPathInterface;
  32. /**
  33.  * Form represents a form.
  34.  *
  35.  * To implement your own form fields, you need to have a thorough understanding
  36.  * of the data flow within a form. A form stores its data in three different
  37.  * representations:
  38.  *
  39.  *   (1) the "model" format required by the form's object
  40.  *   (2) the "normalized" format for internal processing
  41.  *   (3) the "view" format used for display simple fields
  42.  *       or map children model data for compound fields
  43.  *
  44.  * A date field, for example, may store a date as "Y-m-d" string (1) in the
  45.  * object. To facilitate processing in the field, this value is normalized
  46.  * to a DateTime object (2). In the HTML representation of your form, a
  47.  * localized string (3) may be presented to and modified by the user, or it could be an array of values
  48.  * to be mapped to choices fields.
  49.  *
  50.  * In most cases, format (1) and format (2) will be the same. For example,
  51.  * a checkbox field uses a Boolean value for both internal processing and
  52.  * storage in the object. In these cases you need to set a view transformer
  53.  * to convert between formats (2) and (3). You can do this by calling
  54.  * addViewTransformer().
  55.  *
  56.  * In some cases though it makes sense to make format (1) configurable. To
  57.  * demonstrate this, let's extend our above date field to store the value
  58.  * either as "Y-m-d" string or as timestamp. Internally we still want to
  59.  * use a DateTime object for processing. To convert the data from string/integer
  60.  * to DateTime you can set a model transformer by calling
  61.  * addModelTransformer(). The normalized data is then converted to the displayed
  62.  * data as described before.
  63.  *
  64.  * The conversions (1) -> (2) -> (3) use the transform methods of the transformers.
  65.  * The conversions (3) -> (2) -> (1) use the reverseTransform methods of the transformers.
  66.  *
  67.  * @author Fabien Potencier <fabien@symfony.com>
  68.  * @author Bernhard Schussek <bschussek@gmail.com>
  69.  */
  70. class Form implements \IteratorAggregate, FormInterface, ClearableErrorsInterface
  71. {
  72.     /**
  73.      * @var FormConfigInterface
  74.      */
  75.     private $config;
  77.     /**
  78.      * @var FormInterface|null
  79.      */
  80.     private $parent;
  82.     /**
  83.      * @var FormInterface[]|OrderedHashMap A map of FormInterface instances
  84.      */
  85.     private $children;
  87.     /**
  88.      * @var FormError[] An array of FormError instances
  89.      */
  90.     private $errors = [];
  92.     /**
  93.      * @var bool
  94.      */
  95.     private $submitted = false;
  97.     /**
  98.      * @var FormInterface|ClickableInterface|null The button that was used to submit the form
  99.      */
  100.     private $clickedButton;
  102.     /**
  103.      * @var mixed
  104.      */
  105.     private $modelData;
  107.     /**
  108.      * @var mixed
  109.      */
  110.     private $normData;
  112.     /**
  113.      * @var mixed
  114.      */
  115.     private $viewData;
  117.     /**
  118.      * @var array The submitted values that don't belong to any children
  119.      */
  120.     private $extraData = [];
  122.     /**
  123.      * @var TransformationFailedException|null The transformation failure generated during submission, if any
  124.      */
  125.     private $transformationFailure;
  127.     /**
  128.      * Whether the form's data has been initialized.
  129.      *
  130.      * When the data is initialized with its default value, that default value
  131.      * is passed through the transformer chain in order to synchronize the
  132.      * model, normalized and view format for the first time. This is done
  133.      * lazily in order to save performance when {@link setData()} is called
  134.      * manually, making the initialization with the configured default value
  135.      * superfluous.
  136.      *
  137.      * @var bool
  138.      */
  139.     private $defaultDataSet = false;
  141.     /**
  142.      * Whether setData() is currently being called.
  143.      *
  144.      * @var bool
  145.      */
  146.     private $lockSetData = false;
  148.     /**
  149.      * @var string
  150.      */
  151.     private $name = '';
  153.     /**
  154.      * @var bool Whether the form inherits its underlying data from its parent
  155.      */
  156.     private $inheritData;
  158.     /**
  159.      * @var PropertyPathInterface|null
  160.      */
  161.     private $propertyPath;
  163.     /**
  164.      * @throws LogicException if a data mapper is not provided for a compound form
  165.      */
  166.     public function __construct(FormConfigInterface $config)
  167.     {
  168.         // Compound forms always need a data mapper, otherwise calls to
  169.         // `setData` and `add` will not lead to the correct population of
  170.         // the child forms.
  171.         if ($config->getCompound() && !$config->getDataMapper()) {
  172.             throw new LogicException('Compound forms need a data mapper.');
  173.         }
  175.         // If the form inherits the data from its parent, it is not necessary
  176.         // to call setData() with the default data.
  177.         if ($this->inheritData = $config->getInheritData()) {
  178.             $this->defaultDataSet = true;
  179.         }
  181.         $this->config = $config;
  182.         $this->children = new OrderedHashMap();
  183.         $this->name = $config->getName();
  184.     }
  186.     public function __clone()
  187.     {
  188.         $this->children = clone $this->children;
  190.         foreach ($this->children as $key => $child) {
  191.             $this->children[$key] = clone $child;
  192.         }
  193.     }
  195.     /**
  196.      * {@inheritdoc}
  197.      */
  198.     public function getConfig()
  199.     {
  200.         return $this->config;
  201.     }
  203.     /**
  204.      * {@inheritdoc}
  205.      */
  206.     public function getName()
  207.     {
  208.         return $this->name;
  209.     }
  211.     /**
  212.      * {@inheritdoc}
  213.      */
  214.     public function getPropertyPath()
  215.     {
  216.         if ($this->propertyPath || $this->propertyPath = $this->config->getPropertyPath()) {
  217.             return $this->propertyPath;
  218.         }
  220.         if ('' === $this->name) {
  221.             return null;
  222.         }
  224.         $parent = $this->parent;
  226.         while ($parent && $parent->getConfig()->getInheritData()) {
  227.             $parent = $parent->getParent();
  228.         }
  230.         if ($parent && null === $parent->getConfig()->getDataClass()) {
  231.             $this->propertyPath = new PropertyPath('['.$this->name.']');
  232.         } else {
  233.             $this->propertyPath = new PropertyPath($this->name);
  234.         }
  236.         return $this->propertyPath;
  237.     }
  239.     /**
  240.      * {@inheritdoc}
  241.      */
  242.     public function isRequired()
  243.     {
  244.         if (null === $this->parent || $this->parent->isRequired()) {
  245.             return $this->config->getRequired();
  246.         }
  248.         return false;
  249.     }
  251.     /**
  252.      * {@inheritdoc}
  253.      */
  254.     public function isDisabled()
  255.     {
  256.         if (null === $this->parent || !$this->parent->isDisabled()) {
  257.             return $this->config->getDisabled();
  258.         }
  260.         return true;
  261.     }
  263.     /**
  264.      * {@inheritdoc}
  265.      */
  266.     public function setParent(FormInterface $parent = null)
  267.     {
  268.         if ($this->submitted) {
  269.             throw new AlreadySubmittedException('You cannot set the parent of a submitted form.');
  270.         }
  272.         if (null !== $parent && '' === $this->name) {
  273.             throw new LogicException('A form with an empty name cannot have a parent form.');
  274.         }
  276.         $this->parent = $parent;
  278.         return $this;
  279.     }
  281.     /**
  282.      * {@inheritdoc}
  283.      */
  284.     public function getParent()
  285.     {
  286.         return $this->parent;
  287.     }
  289.     /**
  290.      * {@inheritdoc}
  291.      */
  292.     public function getRoot()
  293.     {
  294.         return $this->parent ? $this->parent->getRoot() : $this;
  295.     }
  297.     /**
  298.      * {@inheritdoc}
  299.      */
  300.     public function isRoot()
  301.     {
  302.         return null === $this->parent;
  303.     }
  305.     /**
  306.      * {@inheritdoc}
  307.      */
  308.     public function setData($modelData)
  309.     {
  310.         // If the form is submitted while disabled, it is set to submitted, but the data is not
  311.         // changed. In such cases (i.e. when the form is not initialized yet) don't
  312.         // abort this method.
  313.         if ($this->submitted && $this->defaultDataSet) {
  314.             throw new AlreadySubmittedException('You cannot change the data of a submitted form.');
  315.         }
  317.         // If the form inherits its parent's data, disallow data setting to
  318.         // prevent merge conflicts
  319.         if ($this->inheritData) {
  320.             throw new RuntimeException('You cannot change the data of a form inheriting its parent data.');
  321.         }
  323.         // Don't allow modifications of the configured data if the data is locked
  324.         if ($this->config->getDataLocked() && $modelData !== $this->config->getData()) {
  325.             return $this;
  326.         }
  328.         if (\is_object($modelData) && !$this->config->getByReference()) {
  329.             $modelData = clone $modelData;
  330.         }
  332.         if ($this->lockSetData) {
  333.             throw new RuntimeException('A cycle was detected. Listeners to the PRE_SET_DATA event must not call setData(). You should call setData() on the FormEvent object instead.');
  334.         }
  336.         $this->lockSetData = true;
  337.         $dispatcher = LegacyEventDispatcherProxy::decorate($this->config->getEventDispatcher());
  339.         // Hook to change content of the model data before transformation and mapping children
  340.         if ($dispatcher->hasListeners(FormEvents::PRE_SET_DATA)) {
  341.             $event = new PreSetDataEvent($this, $modelData);
  342.             $dispatcher->dispatch($event, FormEvents::PRE_SET_DATA);
  343.             $modelData = $event->getData();
  344.         }
  346.         // Treat data as strings unless a transformer exists
  347.         if (is_scalar($modelData) && !$this->config->getViewTransformers() && !$this->config->getModelTransformers()) {
  348.             $modelData = (string) $modelData;
  349.         }
  351.         // Synchronize representations - must not change the content!
  352.         // Transformation exceptions are not caught on initialization
  353.         $normData = $this->modelToNorm($modelData);
  354.         $viewData = $this->normToView($normData);
  356.         // Validate if view data matches data class (unless empty)
  357.         if (!FormUtil::isEmpty($viewData)) {
  358.             $dataClass = $this->config->getDataClass();
  360.             if (null !== $dataClass && !$viewData instanceof $dataClass) {
  361.                 $actualType = \is_object($viewData)
  362.                     ? 'an instance of class '.\get_class($viewData)
  363.                     : 'a(n) '.\gettype($viewData);
  365.                 throw new LogicException('The form\'s view data is expected to be an instance of class '.$dataClass.', but is '.$actualType.'. You can avoid this error by setting the "data_class" option to null or by adding a view transformer that transforms '.$actualType.' to an instance of '.$dataClass.'.');
  366.             }
  367.         }
  369.         $this->modelData = $modelData;
  370.         $this->normData = $normData;
  371.         $this->viewData = $viewData;
  372.         $this->defaultDataSet = true;
  373.         $this->lockSetData = false;
  375.         // Compound forms don't need to invoke this method if they don't have children
  376.         if (\count($this->children) > 0) {
  377.             // Update child forms from the data (unless their config data is locked)
  378.             $this->config->getDataMapper()->mapDataToForms($viewData, new \RecursiveIteratorIterator(new InheritDataAwareIterator($this->children)));
  379.         }
  381.         if ($dispatcher->hasListeners(FormEvents::POST_SET_DATA)) {
  382.             $event = new PostSetDataEvent($this, $modelData);
  383.             $dispatcher->dispatch($event, FormEvents::POST_SET_DATA);
  384.         }
  386.         return $this;
  387.     }
  389.     /**
  390.      * {@inheritdoc}
  391.      */
  392.     public function getData()
  393.     {
  394.         if ($this->inheritData) {
  395.             if (!$this->parent) {
  396.                 throw new RuntimeException('The form is configured to inherit its parent\'s data, but does not have a parent.');
  397.             }
  399.             return $this->parent->getData();
  400.         }
  402.         if (!$this->defaultDataSet) {
  403.             if ($this->lockSetData) {
  404.                 throw new RuntimeException('A cycle was detected. Listeners to the PRE_SET_DATA event must not call getData() if the form data has not already been set. You should call getData() on the FormEvent object instead.');
  405.             }
  407.             $this->setData($this->config->getData());
  408.         }
  410.         return $this->modelData;
  411.     }
  413.     /**
  414.      * {@inheritdoc}
  415.      */
  416.     public function getNormData()
  417.     {
  418.         if ($this->inheritData) {
  419.             if (!$this->parent) {
  420.                 throw new RuntimeException('The form is configured to inherit its parent\'s data, but does not have a parent.');
  421.             }
  423.             return $this->parent->getNormData();
  424.         }
  426.         if (!$this->defaultDataSet) {
  427.             if ($this->lockSetData) {
  428.                 throw new RuntimeException('A cycle was detected. Listeners to the PRE_SET_DATA event must not call getNormData() if the form data has not already been set.');
  429.             }
  431.             $this->setData($this->config->getData());
  432.         }
  434.         return $this->normData;
  435.     }
  437.     /**
  438.      * {@inheritdoc}
  439.      */
  440.     public function getViewData()
  441.     {
  442.         if ($this->inheritData) {
  443.             if (!$this->parent) {
  444.                 throw new RuntimeException('The form is configured to inherit its parent\'s data, but does not have a parent.');
  445.             }
  447.             return $this->parent->getViewData();
  448.         }
  450.         if (!$this->defaultDataSet) {
  451.             if ($this->lockSetData) {
  452.                 throw new RuntimeException('A cycle was detected. Listeners to the PRE_SET_DATA event must not call getViewData() if the form data has not already been set.');
  453.             }
  455.             $this->setData($this->config->getData());
  456.         }
  458.         return $this->viewData;
  459.     }
  461.     /**
  462.      * {@inheritdoc}
  463.      */
  464.     public function getExtraData()
  465.     {
  466.         return $this->extraData;
  467.     }
  469.     /**
  470.      * {@inheritdoc}
  471.      */
  472.     public function initialize()
  473.     {
  474.         if (null !== $this->parent) {
  475.             throw new RuntimeException('Only root forms should be initialized.');
  476.         }
  478.         // Guarantee that the *_SET_DATA events have been triggered once the
  479.         // form is initialized. This makes sure that dynamically added or
  480.         // removed fields are already visible after initialization.
  481.         if (!$this->defaultDataSet) {
  482.             $this->setData($this->config->getData());
  483.         }
  485.         return $this;
  486.     }
  488.     /**
  489.      * {@inheritdoc}
  490.      */
  491.     public function handleRequest($request = null)
  492.     {
  493.         $this->config->getRequestHandler()->handleRequest($this, $request);
  495.         return $this;
  496.     }
  498.     /**
  499.      * {@inheritdoc}
  500.      */
  501.     public function submit($submittedData, $clearMissing = true)
  502.     {
  503.         if ($this->submitted) {
  504.             throw new AlreadySubmittedException('A form can only be submitted once.');
  505.         }
  507.         // Initialize errors in the very beginning so we're sure
  508.         // they are collectable during submission only
  509.         $this->errors = [];
  511.         // Obviously, a disabled form should not change its data upon submission.
  512.         if ($this->isDisabled()) {
  513.             $this->submitted = true;
  515.             return $this;
  516.         }
  518.         // The data must be initialized if it was not initialized yet.
  519.         // This is necessary to guarantee that the *_SET_DATA listeners
  520.         // are always invoked before submit() takes place.
  521.         if (!$this->defaultDataSet) {
  522.             $this->setData($this->config->getData());
  523.         }
  525.         // Treat false as NULL to support binding false to checkboxes.
  526.         // Don't convert NULL to a string here in order to determine later
  527.         // whether an empty value has been submitted or whether no value has
  528.         // been submitted at all. This is important for processing checkboxes
  529.         // and radio buttons with empty values.
  530.         if (false === $submittedData) {
  531.             $submittedData = null;
  532.         } elseif (is_scalar($submittedData)) {
  533.             $submittedData = (string) $submittedData;
  534.         } elseif ($this->config->getRequestHandler()->isFileUpload($submittedData)) {
  535.             if (!$this->config->getOption('allow_file_upload')) {
  536.                 $submittedData = null;
  537.                 $this->transformationFailure = new TransformationFailedException('Submitted data was expected to be text or number, file upload given.');
  538.             }
  539.         } elseif (\is_array($submittedData) && !$this->config->getCompound() && !$this->config->hasOption('multiple')) {
  540.             $submittedData = null;
  541.             $this->transformationFailure = new TransformationFailedException('Submitted data was expected to be text or number, array given.');
  542.         }
  544.         $dispatcher = LegacyEventDispatcherProxy::decorate($this->config->getEventDispatcher());
  546.         $modelData = null;
  547.         $normData = null;
  548.         $viewData = null;
  550.         try {
  551.             if (null !== $this->transformationFailure) {
  552.                 throw $this->transformationFailure;
  553.             }
  555.             // Hook to change content of the data submitted by the browser
  556.             if ($dispatcher->hasListeners(FormEvents::PRE_SUBMIT)) {
  557.                 $event = new PreSubmitEvent($this, $submittedData);
  558.                 $dispatcher->dispatch($event, FormEvents::PRE_SUBMIT);
  559.                 $submittedData = $event->getData();
  560.             }
  562.             // Check whether the form is compound.
  563.             // This check is preferable over checking the number of children,
  564.             // since forms without children may also be compound.
  565.             // (think of empty collection forms)
  566.             if ($this->config->getCompound()) {
  567.                 if (null === $submittedData) {
  568.                     $submittedData = [];
  569.                 }
  571.                 if (!\is_array($submittedData)) {
  572.                     throw new TransformationFailedException('Compound forms expect an array or NULL on submission.');
  573.                 }
  575.                 foreach ($this->children as $name => $child) {
  576.                     $isSubmitted = \array_key_exists($name, $submittedData);
  578.                     if ($isSubmitted || $clearMissing) {
  579.                         $child->submit($isSubmitted ? $submittedData[$name] : null, $clearMissing);
  580.                         unset($submittedData[$name]);
  582.                         if (null !== $this->clickedButton) {
  583.                             continue;
  584.                         }
  586.                         if ($child instanceof ClickableInterface && $child->isClicked()) {
  587.                             $this->clickedButton = $child;
  589.                             continue;
  590.                         }
  592.                         if (method_exists($child, 'getClickedButton') && null !== $child->getClickedButton()) {
  593.                             $this->clickedButton = $child->getClickedButton();
  594.                         }
  595.                     }
  596.                 }
  598.                 $this->extraData = $submittedData;
  599.             }
  601.             // Forms that inherit their parents' data also are not processed,
  602.             // because then it would be too difficult to merge the changes in
  603.             // the child and the parent form. Instead, the parent form also takes
  604.             // changes in the grandchildren (i.e. children of the form that inherits
  605.             // its parent's data) into account.
  606.             // (see InheritDataAwareIterator below)
  607.             if (!$this->inheritData) {
  608.                 // If the form is compound, the view data is merged with the data
  609.                 // of the children using the data mapper.
  610.                 // If the form is not compound, the view data is assigned to the submitted data.
  611.                 $viewData = $this->config->getCompound() ? $this->viewData : $submittedData;
  613.                 if (FormUtil::isEmpty($viewData)) {
  614.                     $emptyData = $this->config->getEmptyData();
  616.                     if ($emptyData instanceof \Closure) {
  617.                         $emptyData = $emptyData($this, $viewData);
  618.                     }
  620.                     $viewData = $emptyData;
  621.                 }
  623.                 // Merge form data from children into existing view data
  624.                 // It is not necessary to invoke this method if the form has no children,
  625.                 // even if it is compound.
  626.                 if (\count($this->children) > 0) {
  627.                     // Use InheritDataAwareIterator to process children of
  628.                     // descendants that inherit this form's data.
  629.                     // These descendants will not be submitted normally (see the check
  630.                     // for $this->config->getInheritData() above)
  631.                     $this->config->getDataMapper()->mapFormsToData(
  632.                         new \RecursiveIteratorIterator(new InheritDataAwareIterator($this->children)),
  633.                         $viewData
  634.                     );
  635.                 }
  637.                 // Normalize data to unified representation
  638.                 $normData = $this->viewToNorm($viewData);
  640.                 // Hook to change content of the data in the normalized
  641.                 // representation
  642.                 if ($dispatcher->hasListeners(FormEvents::SUBMIT)) {
  643.                     $event = new SubmitEvent($this, $normData);
  644.                     $dispatcher->dispatch($event, FormEvents::SUBMIT);
  645.                     $normData = $event->getData();
  646.                 }
  648.                 // Synchronize representations - must not change the content!
  649.                 $modelData = $this->normToModel($normData);
  650.                 $viewData = $this->normToView($normData);
  651.             }
  652.         } catch (TransformationFailedException $e) {
  653.             $this->transformationFailure = $e;
  655.             // If $viewData was not yet set, set it to $submittedData so that
  656.             // the erroneous data is accessible on the form.
  657.             // Forms that inherit data never set any data, because the getters
  658.             // forward to the parent form's getters anyway.
  659.             if (null === $viewData && !$this->inheritData) {
  660.                 $viewData = $submittedData;
  661.             }
  662.         }
  664.         $this->submitted = true;
  665.         $this->modelData = $modelData;
  666.         $this->normData = $normData;
  667.         $this->viewData = $viewData;
  669.         if ($dispatcher->hasListeners(FormEvents::POST_SUBMIT)) {
  670.             $event = new PostSubmitEvent($this, $viewData);
  671.             $dispatcher->dispatch($event, FormEvents::POST_SUBMIT);
  672.         }
  674.         return $this;
  675.     }
  677.     /**
  678.      * {@inheritdoc}
  679.      */
  680.     public function addError(FormError $error)
  681.     {
  682.         if (null === $error->getOrigin()) {
  683.             $error->setOrigin($this);
  684.         }
  686.         if ($this->parent && $this->config->getErrorBubbling()) {
  687.             $this->parent->addError($error);
  688.         } else {
  689.             $this->errors[] = $error;
  690.         }
  692.         return $this;
  693.     }
  695.     /**
  696.      * {@inheritdoc}
  697.      */
  698.     public function isSubmitted()
  699.     {
  700.         return $this->submitted;
  701.     }
  703.     /**
  704.      * {@inheritdoc}
  705.      */
  706.     public function isSynchronized()
  707.     {
  708.         return null === $this->transformationFailure;
  709.     }
  711.     /**
  712.      * {@inheritdoc}
  713.      */
  714.     public function getTransformationFailure()
  715.     {
  716.         return $this->transformationFailure;
  717.     }
  719.     /**
  720.      * {@inheritdoc}
  721.      */
  722.     public function isEmpty()
  723.     {
  724.         foreach ($this->children as $child) {
  725.             if (!$child->isEmpty()) {
  726.                 return false;
  727.             }
  728.         }
  730.         return FormUtil::isEmpty($this->modelData) ||
  731.             // arrays, countables
  732.             ((\is_array($this->modelData) || $this->modelData instanceof \Countable) && 0 === \count($this->modelData)) ||
  733.             // traversables that are not countable
  734.             ($this->modelData instanceof \Traversable && 0 === iterator_count($this->modelData)) ||
  735.             // @internal - Do not rely on it, it will be removed in Symfony 5.1.
  736.             (false === $this->modelData && $this->config->getAttribute('_false_is_empty'));
  737.     }
  739.     /**
  740.      * {@inheritdoc}
  741.      */
  742.     public function isValid()
  743.     {
  744.         if (!$this->submitted) {
  745.             throw new LogicException('Cannot check if an unsubmitted form is valid. Call Form::isSubmitted() before Form::isValid().');
  746.         }
  748.         if ($this->isDisabled()) {
  749.             return true;
  750.         }
  752.         return 0 === \count($this->getErrors(true));
  753.     }
  755.     /**
  756.      * Returns the button that was used to submit the form.
  757.      *
  758.      * @return FormInterface|ClickableInterface|null
  759.      */
  760.     public function getClickedButton()
  761.     {
  762.         if ($this->clickedButton) {
  763.             return $this->clickedButton;
  764.         }
  766.         return $this->parent && method_exists($this->parent, 'getClickedButton') ? $this->parent->getClickedButton() : null;
  767.     }
  769.     /**
  770.      * {@inheritdoc}
  771.      */
  772.     public function getErrors($deep = false, $flatten = true)
  773.     {
  774.         $errors = $this->errors;
  776.         // Copy the errors of nested forms to the $errors array
  777.         if ($deep) {
  778.             foreach ($this as $child) {
  779.                 /** @var FormInterface $child */
  780.                 if ($child->isSubmitted() && $child->isValid()) {
  781.                     continue;
  782.                 }
  784.                 $iterator = $child->getErrors(true, $flatten);
  786.                 if (0 === \count($iterator)) {
  787.                     continue;
  788.                 }
  790.                 if ($flatten) {
  791.                     foreach ($iterator as $error) {
  792.                         $errors[] = $error;
  793.                     }
  794.                 } else {
  795.                     $errors[] = $iterator;
  796.                 }
  797.             }
  798.         }
  800.         return new FormErrorIterator($this, $errors);
  801.     }
  803.     /**
  804.      * {@inheritdoc}
  805.      *
  806.      * @return $this
  807.      */
  808.     public function clearErrors(bool $deep = false): self
  809.     {
  810.         $this->errors = [];
  812.         if ($deep) {
  813.             // Clear errors from children
  814.             foreach ($this as $child) {
  815.                 if ($child instanceof ClearableErrorsInterface) {
  816.                     $child->clearErrors(true);
  817.                 }
  818.             }
  819.         }
  821.         return $this;
  822.     }
  824.     /**
  825.      * {@inheritdoc}
  826.      */
  827.     public function all()
  828.     {
  829.         return iterator_to_array($this->children);
  830.     }
  832.     /**
  833.      * {@inheritdoc}
  834.      */
  835.     public function add($child, $type = null, array $options = [])
  836.     {
  837.         if ($this->submitted) {
  838.             throw new AlreadySubmittedException('You cannot add children to a submitted form.');
  839.         }
  841.         if (!$this->config->getCompound()) {
  842.             throw new LogicException('You cannot add children to a simple form. Maybe you should set the option "compound" to true?');
  843.         }
  845.         if (!$child instanceof FormInterface) {
  846.             if (!\is_string($child) && !\is_int($child)) {
  847.                 throw new UnexpectedTypeException($child, 'string or Symfony\Component\Form\FormInterface');
  848.             }
  850.             $child = (string) $child;
  852.             if (null !== $type && !\is_string($type)) {
  853.                 throw new UnexpectedTypeException($type, 'string or null');
  854.             }
  856.             // Never initialize child forms automatically
  857.             $options['auto_initialize'] = false;
  859.             if (null === $type && null === $this->config->getDataClass()) {
  860.                 $type = 'Symfony\Component\Form\Extension\Core\Type\TextType';
  861.             }
  863.             if (null === $type) {
  864.                 $child = $this->config->getFormFactory()->createForProperty($this->config->getDataClass(), $child, null, $options);
  865.             } else {
  866.                 $child = $this->config->getFormFactory()->createNamed($child, $type, null, $options);
  867.             }
  868.         } elseif ($child->getConfig()->getAutoInitialize()) {
  869.             throw new RuntimeException(sprintf('Automatic initialization is only supported on root forms. You should set the "auto_initialize" option to false on the field "%s".', $child->getName()));
  870.         }
  872.         $this->children[$child->getName()] = $child;
  874.         $child->setParent($this);
  876.         // If setData() is currently being called, there is no need to call
  877.         // mapDataToForms() here, as mapDataToForms() is called at the end
  878.         // of setData() anyway. Not doing this check leads to an endless
  879.         // recursion when initializing the form lazily and an event listener
  880.         // (such as ResizeFormListener) adds fields depending on the data:
  881.         //
  882.         //  * setData() is called, the form is not initialized yet
  883.         //  * add() is called by the listener (setData() is not complete, so
  884.         //    the form is still not initialized)
  885.         //  * getViewData() is called
  886.         //  * setData() is called since the form is not initialized yet
  887.         //  * ... endless recursion ...
  888.         //
  889.         // Also skip data mapping if setData() has not been called yet.
  890.         // setData() will be called upon form initialization and data mapping
  891.         // will take place by then.
  892.         if (!$this->lockSetData && $this->defaultDataSet && !$this->inheritData) {
  893.             $viewData = $this->getViewData();
  894.             $this->config->getDataMapper()->mapDataToForms(
  895.                 $viewData,
  896.                 new \RecursiveIteratorIterator(new InheritDataAwareIterator(new \ArrayIterator([$child->getName() => $child])))
  897.             );
  898.         }
  900.         return $this;
  901.     }
  903.     /**
  904.      * {@inheritdoc}
  905.      */
  906.     public function remove($name)
  907.     {
  908.         if ($this->submitted) {
  909.             throw new AlreadySubmittedException('You cannot remove children from a submitted form.');
  910.         }
  912.         if (isset($this->children[$name])) {
  913.             if (!$this->children[$name]->isSubmitted()) {
  914.                 $this->children[$name]->setParent(null);
  915.             }
  917.             unset($this->children[$name]);
  918.         }
  920.         return $this;
  921.     }
  923.     /**
  924.      * {@inheritdoc}
  925.      */
  926.     public function has($name)
  927.     {
  928.         return isset($this->children[$name]);
  929.     }
  931.     /**
  932.      * {@inheritdoc}
  933.      */
  934.     public function get($name)
  935.     {
  936.         if (isset($this->children[$name])) {
  937.             return $this->children[$name];
  938.         }
  940.         throw new OutOfBoundsException(sprintf('Child "%s" does not exist.', $name));
  941.     }
  943.     /**
  944.      * Returns whether a child with the given name exists (implements the \ArrayAccess interface).
  945.      *
  946.      * @param string $name The name of the child
  947.      *
  948.      * @return bool
  949.      */
  950.     public function offsetExists($name)
  951.     {
  952.         return $this->has($name);
  953.     }
  955.     /**
  956.      * Returns the child with the given name (implements the \ArrayAccess interface).
  957.      *
  958.      * @param string $name The name of the child
  959.      *
  960.      * @return FormInterface The child form
  961.      *
  962.      * @throws OutOfBoundsException if the named child does not exist
  963.      */
  964.     public function offsetGet($name)
  965.     {
  966.         return $this->get($name);
  967.     }
  969.     /**
  970.      * Adds a child to the form (implements the \ArrayAccess interface).
  971.      *
  972.      * @param string        $name  Ignored. The name of the child is used
  973.      * @param FormInterface $child The child to be added
  974.      *
  975.      * @throws AlreadySubmittedException if the form has already been submitted
  976.      * @throws LogicException            when trying to add a child to a non-compound form
  977.      *
  978.      * @see self::add()
  979.      */
  980.     public function offsetSet($name, $child)
  981.     {
  982.         $this->add($child);
  983.     }
  985.     /**
  986.      * Removes the child with the given name from the form (implements the \ArrayAccess interface).
  987.      *
  988.      * @param string $name The name of the child to remove
  989.      *
  990.      * @throws AlreadySubmittedException if the form has already been submitted
  991.      */
  992.     public function offsetUnset($name)
  993.     {
  994.         $this->remove($name);
  995.     }
  997.     /**
  998.      * Returns the iterator for this group.
  999.      *
  1000.      * @return \Traversable|FormInterface[]
  1001.      */
  1002.     public function getIterator()
  1003.     {
  1004.         return $this->children;
  1005.     }
  1007.     /**
  1008.      * Returns the number of form children (implements the \Countable interface).
  1009.      *
  1010.      * @return int The number of embedded form children
  1011.      */
  1012.     public function count()
  1013.     {
  1014.         return \count($this->children);
  1015.     }
  1017.     /**
  1018.      * {@inheritdoc}
  1019.      */
  1020.     public function createView(FormView $parent = null)
  1021.     {
  1022.         if (null === $parent && $this->parent) {
  1023.             $parent = $this->parent->createView();
  1024.         }
  1026.         $type = $this->config->getType();
  1027.         $options = $this->config->getOptions();
  1029.         // The methods createView(), buildView() and finishView() are called
  1030.         // explicitly here in order to be able to override either of them
  1031.         // in a custom resolved form type.
  1032.         $view = $type->createView($this, $parent);
  1034.         $type->buildView($view, $this, $options);
  1036.         foreach ($this->children as $name => $child) {
  1037.             $view->children[$name] = $child->createView($view);
  1038.         }
  1040.         $type->finishView($view, $this, $options);
  1042.         return $view;
  1043.     }
  1045.     /**
  1046.      * Normalizes the underlying data if a model transformer is set.
  1047.      *
  1048.      * @return mixed
  1049.      *
  1050.      * @throws TransformationFailedException If the underlying data cannot be transformed to "normalized" format
  1051.      */
  1052.     private function modelToNorm($value)
  1053.     {
  1054.         try {
  1055.             foreach ($this->config->getModelTransformers() as $transformer) {
  1056.                 $value = $transformer->transform($value);
  1057.             }
  1058.         } catch (TransformationFailedException $exception) {
  1059.             throw new TransformationFailedException(sprintf('Unable to transform data for property path "%s": ', $this->getPropertyPath()).$exception->getMessage(), $exception->getCode(), $exception, $exception->getInvalidMessage(), $exception->getInvalidMessageParameters());
  1060.         }
  1062.         return $value;
  1063.     }
  1065.     /**
  1066.      * Reverse transforms a value if a model transformer is set.
  1067.      *
  1068.      * @return mixed
  1069.      *
  1070.      * @throws TransformationFailedException If the value cannot be transformed to "model" format
  1071.      */
  1072.     private function normToModel($value)
  1073.     {
  1074.         try {
  1075.             $transformers = $this->config->getModelTransformers();
  1077.             for ($i = \count($transformers) - 1; $i >= 0; --$i) {
  1078.                 $value = $transformers[$i]->reverseTransform($value);
  1079.             }
  1080.         } catch (TransformationFailedException $exception) {
  1081.             throw new TransformationFailedException(sprintf('Unable to reverse value for property path "%s": ', $this->getPropertyPath()).$exception->getMessage(), $exception->getCode(), $exception, $exception->getInvalidMessage(), $exception->getInvalidMessageParameters());
  1082.         }
  1084.         return $value;
  1085.     }
  1087.     /**
  1088.      * Transforms the value if a view transformer is set.
  1089.      *
  1090.      * @return mixed
  1091.      *
  1092.      * @throws TransformationFailedException If the normalized value cannot be transformed to "view" format
  1093.      */
  1094.     private function normToView($value)
  1095.     {
  1096.         // Scalar values should  be converted to strings to
  1097.         // facilitate differentiation between empty ("") and zero (0).
  1098.         // Only do this for simple forms, as the resulting value in
  1099.         // compound forms is passed to the data mapper and thus should
  1100.         // not be converted to a string before.
  1101.         if (!($transformers = $this->config->getViewTransformers()) && !$this->config->getCompound()) {
  1102.             return null === $value || is_scalar($value) ? (string) $value : $value;
  1103.         }
  1105.         try {
  1106.             foreach ($transformers as $transformer) {
  1107.                 $value = $transformer->transform($value);
  1108.             }
  1109.         } catch (TransformationFailedException $exception) {
  1110.             throw new TransformationFailedException(sprintf('Unable to transform value for property path "%s": ', $this->getPropertyPath()).$exception->getMessage(), $exception->getCode(), $exception, $exception->getInvalidMessage(), $exception->getInvalidMessageParameters());
  1111.         }
  1113.         return $value;
  1114.     }
  1116.     /**
  1117.      * Reverse transforms a value if a view transformer is set.
  1118.      *
  1119.      * @return mixed
  1120.      *
  1121.      * @throws TransformationFailedException If the submitted value cannot be transformed to "normalized" format
  1122.      */
  1123.     private function viewToNorm($value)
  1124.     {
  1125.         if (!$transformers = $this->config->getViewTransformers()) {
  1126.             return '' === $value ? null : $value;
  1127.         }
  1129.         try {
  1130.             for ($i = \count($transformers) - 1; $i >= 0; --$i) {
  1131.                 $value = $transformers[$i]->reverseTransform($value);
  1132.             }
  1133.         } catch (TransformationFailedException $exception) {
  1134.             throw new TransformationFailedException(sprintf('Unable to reverse value for property path "%s": ', $this->getPropertyPath()).$exception->getMessage(), $exception->getCode(), $exception, $exception->getInvalidMessage(), $exception->getInvalidMessageParameters());
  1135.         }
  1137.         return $value;
  1138.     }
  1139. }