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

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