vendor/symfony/form/Extension/Core/Type/FormType.php line 29

  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\Core\Type;
  14. use Symfony\Component\Form\Exception\LogicException;
  15. use Symfony\Component\Form\Extension\Core\DataAccessor\CallbackAccessor;
  16. use Symfony\Component\Form\Extension\Core\DataAccessor\ChainAccessor;
  17. use Symfony\Component\Form\Extension\Core\DataAccessor\PropertyPathAccessor;
  18. use Symfony\Component\Form\Extension\Core\DataMapper\DataMapper;
  19. use Symfony\Component\Form\Extension\Core\EventListener\TrimListener;
  20. use Symfony\Component\Form\FormBuilderInterface;
  21. use Symfony\Component\Form\FormInterface;
  22. use Symfony\Component\Form\FormView;
  23. use Symfony\Component\OptionsResolver\Options;
  24. use Symfony\Component\OptionsResolver\OptionsResolver;
  25. use Symfony\Component\PropertyAccess\PropertyAccess;
  26. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  27. use Symfony\Contracts\Translation\TranslatableInterface;
  29. class FormType extends BaseType
  30. {
  31.     private DataMapper $dataMapper;
  33.     public function __construct(PropertyAccessorInterface $propertyAccessor = null)
  34.     {
  35.         $this->dataMapper = new DataMapper(new ChainAccessor([
  36.             new CallbackAccessor(),
  37.             new PropertyPathAccessor($propertyAccessor ?? PropertyAccess::createPropertyAccessor()),
  38.         ]));
  39.     }
  41.     public function buildForm(FormBuilderInterface $builder, array $options)
  42.     {
  43.         parent::buildForm($builder, $options);
  45.         $isDataOptionSet = \array_key_exists('data', $options);
  47.         $builder
  48.             ->setRequired($options['required'])
  49.             ->setErrorBubbling($options['error_bubbling'])
  50.             ->setEmptyData($options['empty_data'])
  51.             ->setPropertyPath($options['property_path'])
  52.             ->setMapped($options['mapped'])
  53.             ->setByReference($options['by_reference'])
  54.             ->setInheritData($options['inherit_data'])
  55.             ->setCompound($options['compound'])
  56.             ->setData($isDataOptionSet ? $options['data'] : null)
  57.             ->setDataLocked($isDataOptionSet)
  58.             ->setDataMapper($options['compound'] ? $this->dataMapper : null)
  59.             ->setMethod($options['method'])
  60.             ->setAction($options['action']);
  62.         if ($options['trim']) {
  63.             $builder->addEventSubscriber(new TrimListener());
  64.         }
  66.         $builder->setIsEmptyCallback($options['is_empty_callback']);
  67.     }
  69.     public function buildView(FormView $view, FormInterface $form, array $options)
  70.     {
  71.         parent::buildView($view, $form, $options);
  73.         $name = $form->getName();
  74.         $helpTranslationParameters = $options['help_translation_parameters'];
  76.         if ($view->parent) {
  77.             if ('' === $name) {
  78.                 throw new LogicException('Form node with empty name can be used only as root form node.');
  79.             }
  81.             // Complex fields are read-only if they themselves or their parents are.
  82.             if (!isset($view->vars['attr']['readonly']) && isset($view->parent->vars['attr']['readonly']) && false !== $view->parent->vars['attr']['readonly']) {
  83.                 $view->vars['attr']['readonly'] = true;
  84.             }
  86.             $helpTranslationParameters = array_merge($view->parent->vars['help_translation_parameters'], $helpTranslationParameters);
  87.         }
  89.         $formConfig = $form->getConfig();
  90.         $view->vars = array_replace($view->vars, [
  91.             'errors' => $form->getErrors(),
  92.             'valid' => $form->isSubmitted() ? $form->isValid() : true,
  93.             'value' => $form->getViewData(),
  94.             'data' => $form->getNormData(),
  95.             'required' => $form->isRequired(),
  96.             'label_attr' => $options['label_attr'],
  97.             'help' => $options['help'],
  98.             'help_attr' => $options['help_attr'],
  99.             'help_html' => $options['help_html'],
  100.             'help_translation_parameters' => $helpTranslationParameters,
  101.             'compound' => $formConfig->getCompound(),
  102.             'method' => $formConfig->getMethod(),
  103.             'action' => $formConfig->getAction(),
  104.             'submitted' => $form->isSubmitted(),
  105.         ]);
  106.     }
  108.     public function finishView(FormView $view, FormInterface $form, array $options)
  109.     {
  110.         $multipart = false;
  112.         foreach ($view->children as $child) {
  113.             if ($child->vars['multipart']) {
  114.                 $multipart = true;
  115.                 break;
  116.             }
  117.         }
  119.         $view->vars['multipart'] = $multipart;
  120.     }
  122.     public function configureOptions(OptionsResolver $resolver)
  123.     {
  124.         parent::configureOptions($resolver);
  126.         // Derive "data_class" option from passed "data" object
  127.         $dataClass = function (Options $options) {
  128.             return isset($options['data']) && \is_object($options['data']) ? \get_class($options['data']) : null;
  129.         };
  131.         // Derive "empty_data" closure from "data_class" option
  132.         $emptyData = function (Options $options) {
  133.             $class = $options['data_class'];
  135.             if (null !== $class) {
  136.                 return function (FormInterface $form) use ($class) {
  137.                     return $form->isEmpty() && !$form->isRequired() ? null : new $class();
  138.                 };
  139.             }
  141.             return function (FormInterface $form) {
  142.                 return $form->getConfig()->getCompound() ? [] : '';
  143.             };
  144.         };
  146.         // Wrap "post_max_size_message" in a closure to translate it lazily
  147.         $uploadMaxSizeMessage = function (Options $options) {
  148.             return function () use ($options) {
  149.                 return $options['post_max_size_message'];
  150.             };
  151.         };
  153.         // For any form that is not represented by a single HTML control,
  154.         // errors should bubble up by default
  155.         $errorBubbling = function (Options $options) {
  156.             return $options['compound'] && !$options['inherit_data'];
  157.         };
  159.         // If data is given, the form is locked to that data
  160.         // (independent of its value)
  161.         $resolver->setDefined([
  162.             'data',
  163.         ]);
  165.         $resolver->setDefaults([
  166.             'data_class' => $dataClass,
  167.             'empty_data' => $emptyData,
  168.             'trim' => true,
  169.             'required' => true,
  170.             'property_path' => null,
  171.             'mapped' => true,
  172.             'by_reference' => true,
  173.             'error_bubbling' => $errorBubbling,
  174.             'label_attr' => [],
  175.             'inherit_data' => false,
  176.             'compound' => true,
  177.             'method' => 'POST',
  178.             // According to RFC 2396 (http://www.ietf.org/rfc/rfc2396.txt)
  179.             // section 4.2., empty URIs are considered same-document references
  180.             'action' => '',
  181.             'attr' => [],
  182.             'post_max_size_message' => 'The uploaded file was too large. Please try to upload a smaller file.',
  183.             'upload_max_size_message' => $uploadMaxSizeMessage, // internal
  184.             'allow_file_upload' => false,
  185.             'help' => null,
  186.             'help_attr' => [],
  187.             'help_html' => false,
  188.             'help_translation_parameters' => [],
  189.             'invalid_message' => 'This value is not valid.',
  190.             'invalid_message_parameters' => [],
  191.             'is_empty_callback' => null,
  192.             'getter' => null,
  193.             'setter' => null,
  194.         ]);
  196.         $resolver->setAllowedTypes('label_attr', 'array');
  197.         $resolver->setAllowedTypes('action', 'string');
  198.         $resolver->setAllowedTypes('upload_max_size_message', ['callable']);
  199.         $resolver->setAllowedTypes('help', ['string', 'null', TranslatableInterface::class]);
  200.         $resolver->setAllowedTypes('help_attr', 'array');
  201.         $resolver->setAllowedTypes('help_html', 'bool');
  202.         $resolver->setAllowedTypes('is_empty_callback', ['null', 'callable']);
  203.         $resolver->setAllowedTypes('getter', ['null', 'callable']);
  204.         $resolver->setAllowedTypes('setter', ['null', 'callable']);
  206.         $resolver->setInfo('getter', 'A callable that accepts two arguments (the view data and the current form field) and must return a value.');
  207.         $resolver->setInfo('setter', 'A callable that accepts three arguments (a reference to the view data, the submitted value and the current form field).');
  208.     }
  210.     public function getParent(): ?string
  211.     {
  212.         return null;
  213.     }
  215.     public function getBlockPrefix(): string
  216.     {
  217.         return 'form';
  218.     }
  219. }