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

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