vendor/symfony/form/ResolvedFormType.php line 110

  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\EventDispatcher;
  15. use Symfony\Component\Form\Exception\UnexpectedTypeException;
  16. use Symfony\Component\OptionsResolver\Exception\ExceptionInterface;
  17. use Symfony\Component\OptionsResolver\OptionsResolver;
  19. /**
  20.  * A wrapper for a form type and its extensions.
  21.  *
  22.  * @author Bernhard Schussek <bschussek@gmail.com>
  23.  */
  24. class ResolvedFormType implements ResolvedFormTypeInterface
  25. {
  26.     private FormTypeInterface $innerType;
  28.     /**
  29.      * @var FormTypeExtensionInterface[]
  30.      */
  31.     private array $typeExtensions;
  33.     private ?ResolvedFormTypeInterface $parent;
  35.     private OptionsResolver $optionsResolver;
  37.     /**
  38.      * @param FormTypeExtensionInterface[] $typeExtensions
  39.      */
  40.     public function __construct(FormTypeInterface $innerType, array $typeExtensions = [], ResolvedFormTypeInterface $parent = null)
  41.     {
  42.         foreach ($typeExtensions as $extension) {
  43.             if (!$extension instanceof FormTypeExtensionInterface) {
  44.                 throw new UnexpectedTypeException($extension, FormTypeExtensionInterface::class);
  45.             }
  46.         }
  48.         $this->innerType = $innerType;
  49.         $this->typeExtensions = $typeExtensions;
  50.         $this->parent = $parent;
  51.     }
  53.     public function getBlockPrefix(): string
  54.     {
  55.         return $this->innerType->getBlockPrefix();
  56.     }
  58.     public function getParent(): ?ResolvedFormTypeInterface
  59.     {
  60.         return $this->parent;
  61.     }
  63.     public function getInnerType(): FormTypeInterface
  64.     {
  65.         return $this->innerType;
  66.     }
  68.     public function getTypeExtensions(): array
  69.     {
  70.         return $this->typeExtensions;
  71.     }
  73.     public function createBuilder(FormFactoryInterface $factory, string $name, array $options = []): FormBuilderInterface
  74.     {
  75.         try {
  76.             $options = $this->getOptionsResolver()->resolve($options);
  77.         } catch (ExceptionInterface $e) {
  78.             throw new $e(sprintf('An error has occurred resolving the options of the form "%s": ', get_debug_type($this->getInnerType())).$e->getMessage(), $e->getCode(), $e);
  79.         }
  81.         // Should be decoupled from the specific option at some point
  82.         $dataClass = $options['data_class'] ?? null;
  84.         $builder = $this->newBuilder($name, $dataClass, $factory, $options);
  85.         $builder->setType($this);
  87.         return $builder;
  88.     }
  90.     public function createView(FormInterface $form, FormView $parent = null): FormView
  91.     {
  92.         return $this->newView($parent);
  93.     }
  95.     public function buildForm(FormBuilderInterface $builder, array $options)
  96.     {
  97.         $this->parent?->buildForm($builder, $options);
  99.         $this->innerType->buildForm($builder, $options);
  101.         foreach ($this->typeExtensions as $extension) {
  102.             $extension->buildForm($builder, $options);
  103.         }
  104.     }
  106.     public function buildView(FormView $view, FormInterface $form, array $options)
  107.     {
  108.         $this->parent?->buildView($view, $form, $options);
  110.         $this->innerType->buildView($view, $form, $options);
  112.         foreach ($this->typeExtensions as $extension) {
  113.             $extension->buildView($view, $form, $options);
  114.         }
  115.     }
  117.     public function finishView(FormView $view, FormInterface $form, array $options)
  118.     {
  119.         $this->parent?->finishView($view, $form, $options);
  121.         $this->innerType->finishView($view, $form, $options);
  123.         foreach ($this->typeExtensions as $extension) {
  124.             /* @var FormTypeExtensionInterface $extension */
  125.             $extension->finishView($view, $form, $options);
  126.         }
  127.     }
  129.     public function getOptionsResolver(): OptionsResolver
  130.     {
  131.         if (!isset($this->optionsResolver)) {
  132.             if (null !== $this->parent) {
  133.                 $this->optionsResolver = clone $this->parent->getOptionsResolver();
  134.             } else {
  135.                 $this->optionsResolver = new OptionsResolver();
  136.             }
  138.             $this->innerType->configureOptions($this->optionsResolver);
  140.             foreach ($this->typeExtensions as $extension) {
  141.                 $extension->configureOptions($this->optionsResolver);
  142.             }
  143.         }
  145.         return $this->optionsResolver;
  146.     }
  148.     /**
  149.      * Creates a new builder instance.
  150.      *
  151.      * Override this method if you want to customize the builder class.
  152.      */
  153.     protected function newBuilder(string $name, ?string $dataClass, FormFactoryInterface $factory, array $options): FormBuilderInterface
  154.     {
  155.         if ($this->innerType instanceof ButtonTypeInterface) {
  156.             return new ButtonBuilder($name, $options);
  157.         }
  159.         if ($this->innerType instanceof SubmitButtonTypeInterface) {
  160.             return new SubmitButtonBuilder($name, $options);
  161.         }
  163.         return new FormBuilder($name, $dataClass, new EventDispatcher(), $factory, $options);
  164.     }
  166.     /**
  167.      * Creates a new view instance.
  168.      *
  169.      * Override this method if you want to customize the view class.
  170.      */
  171.     protected function newView(FormView $parent = null): FormView
  172.     {
  173.         return new FormView($parent);
  174.     }
  175. }