123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Form;
- use Symfony\Component\EventDispatcher\EventDispatcherInterface;
- use Symfony\Component\Form\Exception\BadMethodCallException;
- use Symfony\Component\Form\Exception\InvalidArgumentException;
- use Symfony\Component\Form\Exception\UnexpectedTypeException;
- /**
- * A builder for creating {@link Form} instances.
- *
- * @author Bernhard Schussek <bschussek@gmail.com>
- */
- class FormBuilder extends FormConfigBuilder implements \IteratorAggregate, FormBuilderInterface
- {
- /**
- * The children of the form builder.
- *
- * @var FormBuilderInterface[]
- */
- private $children = [];
- /**
- * The data of children who haven't been converted to form builders yet.
- *
- * @var array
- */
- private $unresolvedChildren = [];
- public function __construct(?string $name, ?string $dataClass, EventDispatcherInterface $dispatcher, FormFactoryInterface $factory, array $options = [])
- {
- parent::__construct($name, $dataClass, $dispatcher, $options);
- $this->setFormFactory($factory);
- }
- /**
- * {@inheritdoc}
- */
- public function add($child, string $type = null, array $options = [])
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if ($child instanceof FormBuilderInterface) {
- $this->children[$child->getName()] = $child;
- // In case an unresolved child with the same name exists
- unset($this->unresolvedChildren[$child->getName()]);
- return $this;
- }
- if (!\is_string($child) && !\is_int($child)) {
- throw new UnexpectedTypeException($child, 'string or Symfony\Component\Form\FormBuilderInterface');
- }
- if (null !== $type && !\is_string($type)) {
- throw new UnexpectedTypeException($type, 'string or null');
- }
- // Add to "children" to maintain order
- $this->children[$child] = null;
- $this->unresolvedChildren[$child] = [$type, $options];
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function create($name, string $type = null, array $options = [])
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if (null === $type && null === $this->getDataClass()) {
- $type = 'Symfony\Component\Form\Extension\Core\Type\TextType';
- }
- if (null !== $type) {
- return $this->getFormFactory()->createNamedBuilder($name, $type, null, $options);
- }
- return $this->getFormFactory()->createBuilderForProperty($this->getDataClass(), $name, null, $options);
- }
- /**
- * {@inheritdoc}
- */
- public function get($name)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- if (isset($this->unresolvedChildren[$name])) {
- return $this->resolveChild($name);
- }
- if (isset($this->children[$name])) {
- return $this->children[$name];
- }
- throw new InvalidArgumentException(sprintf('The child with the name "%s" does not exist.', $name));
- }
- /**
- * {@inheritdoc}
- */
- public function remove($name)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- unset($this->unresolvedChildren[$name], $this->children[$name]);
- return $this;
- }
- /**
- * {@inheritdoc}
- */
- public function has($name)
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- return isset($this->unresolvedChildren[$name]) || isset($this->children[$name]);
- }
- /**
- * {@inheritdoc}
- */
- public function all()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->resolveChildren();
- return $this->children;
- }
- /**
- * @return int
- */
- public function count()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- return \count($this->children);
- }
- /**
- * {@inheritdoc}
- */
- public function getFormConfig()
- {
- /** @var $config self */
- $config = parent::getFormConfig();
- $config->children = [];
- $config->unresolvedChildren = [];
- return $config;
- }
- /**
- * {@inheritdoc}
- */
- public function getForm()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- $this->resolveChildren();
- $form = new Form($this->getFormConfig());
- foreach ($this->children as $child) {
- // Automatic initialization is only supported on root forms
- $form->add($child->setAutoInitialize(false)->getForm());
- }
- if ($this->getAutoInitialize()) {
- // Automatically initialize the form if it is configured so
- $form->initialize();
- }
- return $form;
- }
- /**
- * {@inheritdoc}
- *
- * @return FormBuilderInterface[]|\Traversable
- */
- public function getIterator()
- {
- if ($this->locked) {
- throw new BadMethodCallException('FormBuilder methods cannot be accessed anymore once the builder is turned into a FormConfigInterface instance.');
- }
- return new \ArrayIterator($this->all());
- }
- /**
- * Converts an unresolved child into a {@link FormBuilderInterface} instance.
- */
- private function resolveChild(string $name): FormBuilderInterface
- {
- [$type, $options] = $this->unresolvedChildren[$name];
- unset($this->unresolvedChildren[$name]);
- return $this->children[$name] = $this->create($name, $type, $options);
- }
- /**
- * Converts all unresolved children into {@link FormBuilder} instances.
- */
- private function resolveChildren()
- {
- foreach ($this->unresolvedChildren as $name => $info) {
- $this->children[$name] = $this->create($name, $info[0], $info[1]);
- }
- $this->unresolvedChildren = [];
- }
- }
|