vendor/symfony/form/Extension/Core/Type/CheckboxType.php line 22

Open in your IDE?
  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\Extension\Core\DataTransformer\BooleanToStringTransformer;
  16. use Symfony\Component\Form\FormBuilderInterface;
  17. use Symfony\Component\Form\FormInterface;
  18. use Symfony\Component\Form\FormView;
  19. use Symfony\Component\OptionsResolver\Options;
  20. use Symfony\Component\OptionsResolver\OptionsResolver;
  22. class CheckboxType extends AbstractType
  23. {
  24.     /**
  25.      * {@inheritdoc}
  26.      */
  27.     public function buildForm(FormBuilderInterface $builder, array $options)
  28.     {
  29.         // Unlike in other types, where the data is NULL by default, it
  30.         // needs to be a Boolean here. setData(null) is not acceptable
  31.         // for checkboxes and radio buttons (unless a custom model
  32.         // transformer handles this case).
  33.         // We cannot solve this case via overriding the "data" option, because
  34.         // doing so also calls setDataLocked(true).
  35.         $builder->setData($options['data'] ?? false);
  36.         $builder->addViewTransformer(new BooleanToStringTransformer($options['value'], $options['false_values']));
  37.     }
  39.     /**
  40.      * {@inheritdoc}
  41.      */
  42.     public function buildView(FormView $view, FormInterface $form, array $options)
  43.     {
  44.         $view->vars = array_replace($view->vars, [
  45.             'value' => $options['value'],
  46.             'checked' => null !== $form->getViewData(),
  47.         ]);
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function configureOptions(OptionsResolver $resolver)
  54.     {
  55.         $emptyData = function (FormInterface $form, $viewData) {
  56.             return $viewData;
  57.         };
  59.         $resolver->setDefaults([
  60.             'value' => '1',
  61.             'empty_data' => $emptyData,
  62.             'compound' => false,
  63.             'false_values' => [null],
  64.             'invalid_message' => function (Options $options, $previousValue) {
  65.                 return ($options['legacy_error_messages'] ?? true)
  66.                     ? $previousValue
  67.                     : 'The checkbox has an invalid value.';
  68.             },
  69.             'is_empty_callback' => static function ($modelData): bool {
  70.                 return false === $modelData;
  71.             },
  72.         ]);
  74.         $resolver->setAllowedTypes('false_values', 'array');
  75.     }
  77.     /**
  78.      * {@inheritdoc}
  79.      */
  80.     public function getBlockPrefix()
  81.     {
  82.         return 'checkbox';
  83.     }
  84. }