Symfony 2.8 - how to create "terms & conditions" check-box which isn't mapped to the underlying model

Question

I'm using Symfony 2.8 and I'm trying to create a registration form containing a "terms & conditions" check-box which isn't mapped to the underlying data model.

I've followed this cookbook article: How to Implement a Simple Registration Form

Everything in the form validation works, except for the the "terms & conditions" check-box. After submitting the form, the check-box validation doesn't get triggered.

This is my code:

namespace Likestripe\AdminBundle\Form\Type;


use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;
use FOS\UserBundle\Form\Type\RegistrationFormType as BaseType;
use Symfony\Component\Validator\Constraints\IsFalse;
use Symfony\Component\Validator\Constraints\IsTrue;


class RegistrationFormType extends AbstractType { //BaseType

/**
 * @param FormBuilderInterface $builder
 * @param array $options
 */
public function buildForm(FormBuilderInterface $builder, array $options) {
    // call parent constructor
    //parent::buildForm($builder, $options);

    // add your custom fields
    $builder->add('salutation', ChoiceType::class,   array('choices'  =>   array('Herr' => 0, 'Frau' => 1), 'choices_as_values' => true));
    $builder->add('firstname',  TextType::class,     array());
    $builder->add('lastname',   TextType::class,     array());
    $builder->remove('username');
    $builder->add('company',    new CompanyFormType());
    $builder->add('conditions', CheckboxType::class, array('mapped' => false, 'constraints' => new IsTrue(array("message" => "Bitte akzeptieren Sie noch die AGB und Nutzungsbedingungen."))));
    $builder->add('submit',     SubmitType::class,   array('label' => 'Registrieren'));
} // end function


public function getParent() {
    return 'FOS\UserBundle\Form\Type\RegistrationFormType';

    // Or for Symfony < 2.8
    // return 'fos_user_registration';
}

/**
 * function deprecated since 2.8 https://github.com/symfony/symfony/blob/2.8/UPGRADE-2.8.md#form
 *
 * @return string
 */
public function getName() {
    //return 'likestripe_user_registration';
    return $this->getBlockPrefix();
} // end function

public function getBlockPrefix() {
    return 'likestripe_user_registration';
}

} // end class

I can't see any difference between my code and the code demonstrated in the cookbook article.

Screen capture of my Symfony debug console:

UPDATE:

As Kamil proposed, I've checked if the 'conditions' check-box form parameter gets posted after submitting the form.
The param gets posted als long as the check-box is checked, but if not, the "conditions" form parameter doesn't get posted at all... this behavior reminds me of this case.

I'm still wondering why the official Symfony documentation proposes a isTrue Validator which doesn't seem to be the solution to check for an unchecked check-box, any suggestions how to fix this?

Checkbox checked:

Checkbox unchecked:

Thanks in advance for your help
ninsky

Answer 1

If you let the 'required' of your CheckboxType to true, the constraints isTrue is not useful because the checkbox will always be true ! If change change that to :

$builder->add('conditions', CheckboxType::class, array('mapped' => false, 'required' => false, 'constraints' => new IsTrue(array("message" => "Bitte akzeptieren Sie noch die AGB und Nutzungsbedingungen."))));

With this configuration you can submit the form and if the box is not checked the constraints will send your message.

Hope this help ...

Answer 2

As a workaround, you can add a form listener to make sure you submit the value. Add following to the bottom of your buildForm() function:

     $builder->addEventListener(FormEvents::PRE_BIND, function (FormEvent $event) {
        $data = $event->getData();
        if (!isset($data['conditions'])) {
            $data['conditions'] = false;
        }
        $event->setData($data)
    });

As another workaround, you can perform a check in controller and show flash message if request headers do not contain 'conditions'.

Answer 3

Symfony docs mention it:

$builder
            ->add('email', EmailType::class);
            // ...
            ->add('termsAccepted', CheckboxType::class, array(
                'mapped' => false,
                'constraints' => new IsTrue(),
            ))
        );

Answer 4

Well, I don't see why is not working for you so in the meantime I give you an alternative way :)

$builder->add('conditions', CheckboxType::class , array('mapped' => false, 'required' => true, 'attr'=>array('onchange'=>"try{setCustomValidity('')}catch(e){}",'oninvalid'=>"setCustomValidity('Bitte akzeptieren Sie noch die AGB und Nutzungsbedingungen.')")));

Hope this work for you.

Answer 5

I've run your code with everything but the CompanyFormType line and it is working as expected.

Could you remove this CompanyFormType line and give it a try ?

Answer 6

You have to set the validation group Overriding Default FOSUserBundle Forms

By default, the Registration validation group is used when validating a new user registration. Unless you have overridden this value in the configuration, make sure you add the validation group named Registration to your name property.

How to do that you can find out here: Overriding Default FOSUserBundle Validation