vendor/symfony/form/FormBuilder.php line 74

  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\EventDispatcherInterface;
  15. use Symfony\Component\Form\Exception\BadMethodCallException;
  16. use Symfony\Component\Form\Exception\InvalidArgumentException;
  17. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  18. use Symfony\Component\Form\Extension\Core\Type\TextType;
  20. /**
  21.  * A builder for creating {@link Form} instances.
  22.  *
  23.  * @author Bernhard Schussek <bschussek@gmail.com>
  24.  *
  25.  * @implements \IteratorAggregate<string, FormBuilderInterface>
  26.  */
  27. class FormBuilder extends FormConfigBuilder implements \IteratorAggregate, FormBuilderInterface
  28. {
  29.     /**
  30.      * The children of the form builder.
  31.      *
  32.      * @var FormBuilderInterface[]
  33.      */
  34.     private array $children = [];
  36.     /**
  37.      * The data of children who haven't been converted to form builders yet.
  38.      */
  39.     private array $unresolvedChildren = [];
  41.     public function __construct(?string $name, ?string $dataClass, EventDispatcherInterface $dispatcher, FormFactoryInterface $factory, array $options = [])
  42.     {
  43.         parent::__construct($name, $dataClass, $dispatcher, $options);
  45.         $this->setFormFactory($factory);
  46.     }
  48.     public function add(FormBuilderInterface|string $child, string $type = null, array $options = []): static
  49.     {
  50.         if ($this->locked) {
  51.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  52.         }
  54.         if ($child instanceof FormBuilderInterface) {
  55.             $this->children[$child->getName()] = $child;
  57.             // In case an unresolved child with the same name exists
  58.             unset($this->unresolvedChildren[$child->getName()]);
  60.             return $this;
  61.         }
  63.         if (!\is_string($child) && !\is_int($child)) {
  64.             throw new UnexpectedTypeException($child, 'string or Symfony\Component\Form\FormBuilderInterface');
  65.         }
  67.         // Add to "children" to maintain order
  68.         $this->children[$child] = null;
  69.         $this->unresolvedChildren[$child] = [$type, $options];
  71.         return $this;
  72.     }
  74.     public function create(string $name, string $type = null, array $options = []): FormBuilderInterface
  75.     {
  76.         if ($this->locked) {
  77.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  78.         }
  80.         if (null === $type && null === $this->getDataClass()) {
  81.             $type = TextType::class;
  82.         }
  84.         if (null !== $type) {
  85.             return $this->getFormFactory()->createNamedBuilder($name, $type, null, $options);
  86.         }
  88.         return $this->getFormFactory()->createBuilderForProperty($this->getDataClass(), $name, null, $options);
  89.     }
  91.     public function get(string $name): FormBuilderInterface
  92.     {
  93.         if ($this->locked) {
  94.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  95.         }
  97.         if (isset($this->unresolvedChildren[$name])) {
  98.             return $this->resolveChild($name);
  99.         }
  101.         if (isset($this->children[$name])) {
  102.             return $this->children[$name];
  103.         }
  105.         throw new InvalidArgumentException(sprintf('The child with the name "%s" does not exist.', $name));
  106.     }
  108.     public function remove(string $name): static
  109.     {
  110.         if ($this->locked) {
  111.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  112.         }
  114.         unset($this->unresolvedChildren[$name], $this->children[$name]);
  116.         return $this;
  117.     }
  119.     public function has(string $name): bool
  120.     {
  121.         if ($this->locked) {
  122.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  123.         }
  125.         return isset($this->unresolvedChildren[$name]) || isset($this->children[$name]);
  126.     }
  128.     public function all(): array
  129.     {
  130.         if ($this->locked) {
  131.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  132.         }
  134.         $this->resolveChildren();
  136.         return $this->children;
  137.     }
  139.     public function count(): int
  140.     {
  141.         if ($this->locked) {
  142.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  143.         }
  145.         return \count($this->children);
  146.     }
  148.     public function getFormConfig(): FormConfigInterface
  149.     {
  150.         /** @var $config self */
  151.         $config = parent::getFormConfig();
  153.         $config->children = [];
  154.         $config->unresolvedChildren = [];
  156.         return $config;
  157.     }
  159.     public function getForm(): FormInterface
  160.     {
  161.         if ($this->locked) {
  162.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  163.         }
  165.         $this->resolveChildren();
  167.         $form = new Form($this->getFormConfig());
  169.         foreach ($this->children as $child) {
  170.             // Automatic initialization is only supported on root forms
  171.             $form->add($child->setAutoInitialize(false)->getForm());
  172.         }
  174.         if ($this->getAutoInitialize()) {
  175.             // Automatically initialize the form if it is configured so
  176.             $form->initialize();
  177.         }
  179.         return $form;
  180.     }
  182.     /**
  183.      * @return \Traversable<string, FormBuilderInterface>
  184.      */
  185.     public function getIterator(): \Traversable
  186.     {
  187.         if ($this->locked) {
  188.             throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
  189.         }
  191.         return new \ArrayIterator($this->all());
  192.     }
  194.     /**
  195.      * Converts an unresolved child into a {@link FormBuilderInterface} instance.
  196.      */
  197.     private function resolveChild(string $name): FormBuilderInterface
  198.     {
  199.         [$type, $options] = $this->unresolvedChildren[$name];
  201.         unset($this->unresolvedChildren[$name]);
  203.         return $this->children[$name] = $this->create($name, $type, $options);
  204.     }
  206.     /**
  207.      * Converts all unresolved children into {@link FormBuilder} instances.
  208.      */
  209.     private function resolveChildren()
  210.     {
  211.         foreach ($this->unresolvedChildren as $name => $info) {
  212.             $this->children[$name] = $this->create($name, $info[0], $info[1]);
  213.         }
  215.         $this->unresolvedChildren = [];
  216.     }
  217. }