vendor/symfony/form/Extension/Core/Type/ChoiceType.php line 50

  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\AbstractType;
  15. use Symfony\Component\Form\ChoiceList\ChoiceListInterface;
  16. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceAttr;
  17. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceFieldName;
  18. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceFilter;
  19. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceLabel;
  20. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceLoader;
  21. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceTranslationParameters;
  22. use Symfony\Component\Form\ChoiceList\Factory\Cache\ChoiceValue;
  23. use Symfony\Component\Form\ChoiceList\Factory\Cache\GroupBy;
  24. use Symfony\Component\Form\ChoiceList\Factory\Cache\PreferredChoice;
  25. use Symfony\Component\Form\ChoiceList\Factory\CachingFactoryDecorator;
  26. use Symfony\Component\Form\ChoiceList\Factory\ChoiceListFactoryInterface;
  27. use Symfony\Component\Form\ChoiceList\Factory\DefaultChoiceListFactory;
  28. use Symfony\Component\Form\ChoiceList\Factory\PropertyAccessDecorator;
  29. use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
  30. use Symfony\Component\Form\ChoiceList\View\ChoiceGroupView;
  31. use Symfony\Component\Form\ChoiceList\View\ChoiceListView;
  32. use Symfony\Component\Form\ChoiceList\View\ChoiceView;
  33. use Symfony\Component\Form\Exception\TransformationFailedException;
  34. use Symfony\Component\Form\Extension\Core\DataMapper\CheckboxListMapper;
  35. use Symfony\Component\Form\Extension\Core\DataMapper\RadioListMapper;
  36. use Symfony\Component\Form\Extension\Core\DataTransformer\ChoicesToValuesTransformer;
  37. use Symfony\Component\Form\Extension\Core\DataTransformer\ChoiceToValueTransformer;
  38. use Symfony\Component\Form\Extension\Core\EventListener\MergeCollectionListener;
  39. use Symfony\Component\Form\FormBuilderInterface;
  40. use Symfony\Component\Form\FormError;
  41. use Symfony\Component\Form\FormEvent;
  42. use Symfony\Component\Form\FormEvents;
  43. use Symfony\Component\Form\FormInterface;
  44. use Symfony\Component\Form\FormView;
  45. use Symfony\Component\OptionsResolver\Options;
  46. use Symfony\Component\OptionsResolver\OptionsResolver;
  47. use Symfony\Component\PropertyAccess\PropertyPath;
  48. use Symfony\Contracts\Translation\TranslatorInterface;
  50. class ChoiceType extends AbstractType
  51. {
  52.     private ChoiceListFactoryInterface $choiceListFactory;
  53.     private ?TranslatorInterface $translator;
  55.     public function __construct(ChoiceListFactoryInterface $choiceListFactory = null, TranslatorInterface $translator = null)
  56.     {
  57.         $this->choiceListFactory = $choiceListFactory ?? new CachingFactoryDecorator(
  58.             new PropertyAccessDecorator(
  59.                 new DefaultChoiceListFactory()
  60.             )
  61.         );
  62.         $this->translator = $translator;
  63.     }
  65.     public function buildForm(FormBuilderInterface $builder, array $options)
  66.     {
  67.         $unknownValues = [];
  68.         $choiceList = $this->createChoiceList($options);
  69.         $builder->setAttribute('choice_list', $choiceList);
  71.         if ($options['expanded']) {
  72.             $builder->setDataMapper($options['multiple'] ? new CheckboxListMapper() : new RadioListMapper());
  74.             // Initialize all choices before doing the index check below.
  75.             // This helps in cases where index checks are optimized for non
  76.             // initialized choice lists. For example, when using an SQL driver,
  77.             // the index check would read in one SQL query and the initialization
  78.             // requires another SQL query. When the initialization is done first,
  79.             // one SQL query is sufficient.
  81.             $choiceListView = $this->createChoiceListView($choiceList, $options);
  82.             $builder->setAttribute('choice_list_view', $choiceListView);
  84.             // Check if the choices already contain the empty value
  85.             // Only add the placeholder option if this is not the case
  86.             if (null !== $options['placeholder'] && 0 === \count($choiceList->getChoicesForValues(['']))) {
  87.                 $placeholderView = new ChoiceView(null, '', $options['placeholder']);
  89.                 // "placeholder" is a reserved name
  90.                 $this->addSubForm($builder, 'placeholder', $placeholderView, $options);
  91.             }
  93.             $this->addSubForms($builder, $choiceListView->preferredChoices, $options);
  94.             $this->addSubForms($builder, $choiceListView->choices, $options);
  95.         }
  97.         if ($options['expanded'] || $options['multiple']) {
  98.             // Make sure that scalar, submitted values are converted to arrays
  99.             // which can be submitted to the checkboxes/radio buttons
  100.             $builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) use ($choiceList, $options, &$unknownValues) {
  101.                 $form = $event->getForm();
  102.                 $data = $event->getData();
  104.                 // Since the type always use mapper an empty array will not be
  105.                 // considered as empty in Form::submit(), we need to evaluate
  106.                 // empty data here so its value is submitted to sub forms
  107.                 if (null === $data) {
  108.                     $emptyData = $form->getConfig()->getEmptyData();
  109.                     $data = $emptyData instanceof \Closure ? $emptyData($form, $data) : $emptyData;
  110.                 }
  112.                 // Convert the submitted data to a string, if scalar, before
  113.                 // casting it to an array
  114.                 if (!\is_array($data)) {
  115.                     if ($options['multiple']) {
  116.                         throw new TransformationFailedException('Expected an array.');
  117.                     }
  119.                     $data = (array) (string) $data;
  120.                 }
  122.                 // A map from submitted values to integers
  123.                 $valueMap = array_flip($data);
  125.                 // Make a copy of the value map to determine whether any unknown
  126.                 // values were submitted
  127.                 $unknownValues = $valueMap;
  129.                 // Reconstruct the data as mapping from child names to values
  130.                 $knownValues = [];
  132.                 if ($options['expanded']) {
  133.                     /** @var FormInterface $child */
  134.                     foreach ($form as $child) {
  135.                         $value = $child->getConfig()->getOption('value');
  137.                         // Add the value to $data with the child's name as key
  138.                         if (isset($valueMap[$value])) {
  139.                             $knownValues[$child->getName()] = $value;
  140.                             unset($unknownValues[$value]);
  141.                             continue;
  142.                         } else {
  143.                             $knownValues[$child->getName()] = null;
  144.                         }
  145.                     }
  146.                 } else {
  147.                     foreach ($choiceList->getChoicesForValues($data) as $key => $choice) {
  148.                         $knownValues[] = $data[$key];
  149.                         unset($unknownValues[$data[$key]]);
  150.                     }
  151.                 }
  153.                 // The empty value is always known, independent of whether a
  154.                 // field exists for it or not
  155.                 unset($unknownValues['']);
  157.                 // Throw exception if unknown values were submitted (multiple choices will be handled in a different event listener below)
  158.                 if (\count($unknownValues) > 0 && !$options['multiple']) {
  159.                     throw new TransformationFailedException(sprintf('The choices "%s" do not exist in the choice list.', implode('", "', array_keys($unknownValues))));
  160.                 }
  162.                 $event->setData($knownValues);
  163.             });
  164.         }
  166.         if ($options['multiple']) {
  167.             $messageTemplate = $options['invalid_message'] ?? 'The value {{ value }} is not valid.';
  169.             $builder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event) use (&$unknownValues, $messageTemplate) {
  170.                 // Throw exception if unknown values were submitted
  171.                 if (\count($unknownValues) > 0) {
  172.                     $form = $event->getForm();
  174.                     $clientDataAsString = \is_scalar($form->getViewData()) ? (string) $form->getViewData() : (\is_array($form->getViewData()) ? implode('", "', array_keys($unknownValues)) : \gettype($form->getViewData()));
  176.                     if (null !== $this->translator) {
  177.                         $message = $this->translator->trans($messageTemplate, ['{{ value }}' => $clientDataAsString], 'validators');
  178.                     } else {
  179.                         $message = strtr($messageTemplate, ['{{ value }}' => $clientDataAsString]);
  180.                     }
  182.                     $form->addError(new FormError($message, $messageTemplate, ['{{ value }}' => $clientDataAsString], null, new TransformationFailedException(sprintf('The choices "%s" do not exist in the choice list.', $clientDataAsString))));
  183.                 }
  184.             });
  186.             // <select> tag with "multiple" option or list of checkbox inputs
  187.             $builder->addViewTransformer(new ChoicesToValuesTransformer($choiceList));
  188.         } else {
  189.             // <select> tag without "multiple" option or list of radio inputs
  190.             $builder->addViewTransformer(new ChoiceToValueTransformer($choiceList));
  191.         }
  193.         if ($options['multiple'] && $options['by_reference']) {
  194.             // Make sure the collection created during the client->norm
  195.             // transformation is merged back into the original collection
  196.             $builder->addEventSubscriber(new MergeCollectionListener(true, true));
  197.         }
  199.         // To avoid issues when the submitted choices are arrays (i.e. array to string conversions),
  200.         // we have to ensure that all elements of the submitted choice data are NULL, strings or ints.
  201.         $builder->addEventListener(FormEvents::PRE_SUBMIT, function (FormEvent $event) {
  202.             $data = $event->getData();
  204.             if (!\is_array($data)) {
  205.                 return;
  206.             }
  208.             foreach ($data as $v) {
  209.                 if (null !== $v && !\is_string($v) && !\is_int($v)) {
  210.                     throw new TransformationFailedException('All choices submitted must be NULL, strings or ints.');
  211.                 }
  212.             }
  213.         }, 256);
  214.     }
  216.     public function buildView(FormView $view, FormInterface $form, array $options)
  217.     {
  218.         $choiceTranslationDomain = $options['choice_translation_domain'];
  219.         if ($view->parent && null === $choiceTranslationDomain) {
  220.             $choiceTranslationDomain = $view->vars['translation_domain'];
  221.         }
  223.         /** @var ChoiceListInterface $choiceList */
  224.         $choiceList = $form->getConfig()->getAttribute('choice_list');
  226.         /** @var ChoiceListView $choiceListView */
  227.         $choiceListView = $form->getConfig()->hasAttribute('choice_list_view')
  228.             ? $form->getConfig()->getAttribute('choice_list_view')
  229.             : $this->createChoiceListView($choiceList, $options);
  231.         $view->vars = array_replace($view->vars, [
  232.             'multiple' => $options['multiple'],
  233.             'expanded' => $options['expanded'],
  234.             'preferred_choices' => $choiceListView->preferredChoices,
  235.             'choices' => $choiceListView->choices,
  236.             'separator' => '-------------------',
  237.             'placeholder' => null,
  238.             'choice_translation_domain' => $choiceTranslationDomain,
  239.             'choice_translation_parameters' => $options['choice_translation_parameters'],
  240.         ]);
  242.         // The decision, whether a choice is selected, is potentially done
  243.         // thousand of times during the rendering of a template. Provide a
  244.         // closure here that is optimized for the value of the form, to
  245.         // avoid making the type check inside the closure.
  246.         if ($options['multiple']) {
  247.             $view->vars['is_selected'] = function ($choice, array $values) {
  248.                 return \in_array($choice, $values, true);
  249.             };
  250.         } else {
  251.             $view->vars['is_selected'] = function ($choice, $value) {
  252.                 return $choice === $value;
  253.             };
  254.         }
  256.         // Check if the choices already contain the empty value
  257.         $view->vars['placeholder_in_choices'] = $choiceListView->hasPlaceholder();
  259.         // Only add the empty value option if this is not the case
  260.         if (null !== $options['placeholder'] && !$view->vars['placeholder_in_choices']) {
  261.             $view->vars['placeholder'] = $options['placeholder'];
  262.         }
  264.         if ($options['multiple'] && !$options['expanded']) {
  265.             // Add "[]" to the name in case a select tag with multiple options is
  266.             // displayed. Otherwise only one of the selected options is sent in the
  267.             // POST request.
  268.             $view->vars['full_name'] .= '[]';
  269.         }
  270.     }
  272.     public function finishView(FormView $view, FormInterface $form, array $options)
  273.     {
  274.         if ($options['expanded']) {
  275.             // Radio buttons should have the same name as the parent
  276.             $childName = $view->vars['full_name'];
  278.             // Checkboxes should append "[]" to allow multiple selection
  279.             if ($options['multiple']) {
  280.                 $childName .= '[]';
  281.             }
  283.             foreach ($view as $childView) {
  284.                 $childView->vars['full_name'] = $childName;
  285.             }
  286.         }
  287.     }
  289.     public function configureOptions(OptionsResolver $resolver)
  290.     {
  291.         $emptyData = function (Options $options) {
  292.             if ($options['expanded'] && !$options['multiple']) {
  293.                 return null;
  294.             }
  296.             if ($options['multiple']) {
  297.                 return [];
  298.             }
  300.             return '';
  301.         };
  303.         $placeholderDefault = function (Options $options) {
  304.             return $options['required'] ? null : '';
  305.         };
  307.         $placeholderNormalizer = function (Options $options, $placeholder) {
  308.             if ($options['multiple']) {
  309.                 // never use an empty value for this case
  310.                 return null;
  311.             } elseif ($options['required'] && ($options['expanded'] || isset($options['attr']['size']) && $options['attr']['size'] > 1)) {
  312.                 // placeholder for required radio buttons or a select with size > 1 does not make sense
  313.                 return null;
  314.             } elseif (false === $placeholder) {
  315.                 // an empty value should be added but the user decided otherwise
  316.                 return null;
  317.             } elseif ($options['expanded'] && '' === $placeholder) {
  318.                 // never use an empty label for radio buttons
  319.                 return 'None';
  320.             }
  322.             // empty value has been set explicitly
  323.             return $placeholder;
  324.         };
  326.         $compound = function (Options $options) {
  327.             return $options['expanded'];
  328.         };
  330.         $choiceTranslationDomainNormalizer = function (Options $options, $choiceTranslationDomain) {
  331.             if (true === $choiceTranslationDomain) {
  332.                 return $options['translation_domain'];
  333.             }
  335.             return $choiceTranslationDomain;
  336.         };
  338.         $resolver->setDefaults([
  339.             'multiple' => false,
  340.             'expanded' => false,
  341.             'choices' => [],
  342.             'choice_filter' => null,
  343.             'choice_loader' => null,
  344.             'choice_label' => null,
  345.             'choice_name' => null,
  346.             'choice_value' => null,
  347.             'choice_attr' => null,
  348.             'choice_translation_parameters' => [],
  349.             'preferred_choices' => [],
  350.             'group_by' => null,
  351.             'empty_data' => $emptyData,
  352.             'placeholder' => $placeholderDefault,
  353.             'error_bubbling' => false,
  354.             'compound' => $compound,
  355.             // The view data is always a string or an array of strings,
  356.             // even if the "data" option is manually set to an object.
  357.             // See https://github.com/symfony/symfony/pull/5582
  358.             'data_class' => null,
  359.             'choice_translation_domain' => true,
  360.             'trim' => false,
  361.             'invalid_message' => 'The selected choice is invalid.',
  362.         ]);
  364.         $resolver->setNormalizer('placeholder', $placeholderNormalizer);
  365.         $resolver->setNormalizer('choice_translation_domain', $choiceTranslationDomainNormalizer);
  367.         $resolver->setAllowedTypes('choices', ['null', 'array', \Traversable::class]);
  368.         $resolver->setAllowedTypes('choice_translation_domain', ['null', 'bool', 'string']);
  369.         $resolver->setAllowedTypes('choice_loader', ['null', ChoiceLoaderInterface::class, ChoiceLoader::class]);
  370.         $resolver->setAllowedTypes('choice_filter', ['null', 'callable', 'string', PropertyPath::class, ChoiceFilter::class]);
  371.         $resolver->setAllowedTypes('choice_label', ['null', 'bool', 'callable', 'string', PropertyPath::class, ChoiceLabel::class]);
  372.         $resolver->setAllowedTypes('choice_name', ['null', 'callable', 'string', PropertyPath::class, ChoiceFieldName::class]);
  373.         $resolver->setAllowedTypes('choice_value', ['null', 'callable', 'string', PropertyPath::class, ChoiceValue::class]);
  374.         $resolver->setAllowedTypes('choice_attr', ['null', 'array', 'callable', 'string', PropertyPath::class, ChoiceAttr::class]);
  375.         $resolver->setAllowedTypes('choice_translation_parameters', ['null', 'array', 'callable', ChoiceTranslationParameters::class]);
  376.         $resolver->setAllowedTypes('preferred_choices', ['array', \Traversable::class, 'callable', 'string', PropertyPath::class, PreferredChoice::class]);
  377.         $resolver->setAllowedTypes('group_by', ['null', 'callable', 'string', PropertyPath::class, GroupBy::class]);
  378.     }
  380.     public function getBlockPrefix(): string
  381.     {
  382.         return 'choice';
  383.     }
  385.     /**
  386.      * Adds the sub fields for an expanded choice field.
  387.      */
  388.     private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
  389.     {
  390.         foreach ($choiceViews as $name => $choiceView) {
  391.             // Flatten groups
  392.             if (\is_array($choiceView)) {
  393.                 $this->addSubForms($builder, $choiceView, $options);
  394.                 continue;
  395.             }
  397.             if ($choiceView instanceof ChoiceGroupView) {
  398.                 $this->addSubForms($builder, $choiceView->choices, $options);
  399.                 continue;
  400.             }
  402.             $this->addSubForm($builder, $name, $choiceView, $options);
  403.         }
  404.     }
  406.     private function addSubForm(FormBuilderInterface $builder, string $name, ChoiceView $choiceView, array $options)
  407.     {
  408.         $choiceOpts = [
  409.             'value' => $choiceView->value,
  410.             'label' => $choiceView->label,
  411.             'label_html' => $options['label_html'],
  412.             'attr' => $choiceView->attr,
  413.             'label_translation_parameters' => $choiceView->labelTranslationParameters,
  414.             'translation_domain' => $options['choice_translation_domain'],
  415.             'block_name' => 'entry',
  416.         ];
  418.         if ($options['multiple']) {
  419.             $choiceType = CheckboxType::class;
  420.             // The user can check 0 or more checkboxes. If required
  421.             // is true, they are required to check all of them.
  422.             $choiceOpts['required'] = false;
  423.         } else {
  424.             $choiceType = RadioType::class;
  425.         }
  427.         $builder->add($name, $choiceType, $choiceOpts);
  428.     }
  430.     private function createChoiceList(array $options)
  431.     {
  432.         if (null !== $options['choice_loader']) {
  433.             return $this->choiceListFactory->createListFromLoader(
  434.                 $options['choice_loader'],
  435.                 $options['choice_value'],
  436.                 $options['choice_filter']
  437.             );
  438.         }
  440.         // Harden against NULL values (like in EntityType and ModelType)
  441.         $choices = null !== $options['choices'] ? $options['choices'] : [];
  443.         return $this->choiceListFactory->createListFromChoices(
  444.             $choices,
  445.             $options['choice_value'],
  446.             $options['choice_filter']
  447.         );
  448.     }
  450.     private function createChoiceListView(ChoiceListInterface $choiceList, array $options)
  451.     {
  452.         return $this->choiceListFactory->createView(
  453.             $choiceList,
  454.             $options['preferred_choices'],
  455.             $options['choice_label'],
  456.             $options['choice_name'],
  457.             $options['group_by'],
  458.             $options['choice_attr'],
  459.             $options['choice_translation_parameters']
  460.         );
  461.     }
  462. }