Choice type expanded with boolean choices with choices_as_values always preselects `false` value #17718

webdevilopers · 2016-02-07T14:43:28Z

I've updated to 2.7 and changed my choice types to use choices_as_values.
Most of my choices are simple "No" or "Yes". But they must not be preselected - the user is forced to choose. That is why none of my radio buttons is initially checked.

I tried this with 2.7:

$builder->add('aberdeenBlind', 'choice', array(
                'choices' => array(
                    'Ja' => true,
                    'Nein' => false
                ),
                'choices_as_values' => true,
                'expanded' => true,
                'required' => true
            ))

Unfortunately the second radio button (false => 'Nein') is preselected. This also happens when flipping the order of the choices. The false choice is always preselected.

I played around with other options e.g. placeholder, empty_* etc. but then I recognized:
This only seems to happen when using boolean values. The following example would not preselect any value:

$builder->add('aberdeenBlind', 'choice', array(
                'choices' => array(
                    'Ja' => 'Y', // or '1'
                    'Nein' => 'N' // or '0'
                ),
                'choices_as_values' => true,
                'expanded' => true,
                'required' => true
            ))

Possibly related:

The text was updated successfully, but these errors were encountered:

raziel057 · 2016-02-08T07:48:37Z

This is the same problem as #17677

webdevilopers · 2016-02-08T11:58:24Z

You are right @raziel057 . I browsed the issues before posting but didn't look for e.g. placeholder.
Should we keep both issues open @javiereguiluz ?

javiereguiluz · 2016-02-08T12:01:39Z

If it's the same bug, we usually close the new one in favor of the old one (unless the new one provides more info or engages a better discussion).

webdevilopers · 2016-02-08T12:14:22Z

I think it is important to note that the issue is not linked to the placeholder option.
It looks like it is caused by a boolean choice false itself. The value for the choice is an empty string.
Since no data has been populated for the form the field type thinks the values match and pre-selects the radio button.

I will add a dump too for my example above:

raziel057 · 2016-02-08T16:39:13Z

In fact the string cast for false is the empty value which conflicts with the empty value of the placeholder.

To avoid this issue, I made a custom BooleanType:

namespace PTC\CoreBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;

use PTC\CoreBundle\Form\DataTransformer\StringToBooleanTransformer;

class PtcBooleanType extends AbstractType
{
    /**
     * {@inheritdoc}
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->addModelTransformer(new StringToBooleanTransformer('1', '0'));
    }

    /**
     * {@inheritdoc}
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'choices' => array(
                'yes' => '1',
                'no' => '0',
            ),
        ));

        $resolver->addAllowedValues('multiple', false);
    }

    /**
     * {@inheritdoc}
     */
    public function getParent()
    {
        return ChoiceType::class;
    }
}

With a String to Boolean Transformer:

<?php
namespace PTC\CoreBundle\Form\DataTransformer;

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\TransformationFailedException;

class StringToBooleanTransformer implements DataTransformerInterface
{
    /**
     * @var string
     */
    private $trueValue;

    /**
     * @var string
     */
    private $falseValue;

    /**
     * @param string $trueValue
     * @param string $falseValue
     */
    public function __construct($trueValue, $falseValue)
    {
        $this->trueValue = $trueValue;
        $this->falseValue = $falseValue;
    }

    /**
     * {@inheritDoc}
     */
    public function transform($value)
    {
        if (null === $value) {
             return null;
        }

        if (!is_bool($value)) {
            throw new TransformationFailedException('Expected a Boolean.');
        }

        return true === $value ? $this->trueValue : $this->falseValue;
    }

    /**
     * {@inheritDoc}
     */
    public function reverseTransform($value)
    {
        if (null === $value) {
            return null;
        }

        if (!is_string($value)) {
            throw new TransformationFailedException('Expected a string.');
        }

        return $this->trueValue === $value;
    }
}

xabbuh · 2016-02-09T11:56:35Z

closing as a duplicate of #17677

javiereguiluz added Form Bug labels Feb 7, 2016

carsonbot added the Status: Needs Review label Feb 7, 2016

xabbuh closed this as completed Feb 9, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Choice type expanded with boolean choices with choices_as_values always preselects `false` value #17718

Choice type expanded with boolean choices with choices_as_values always preselects `false` value #17718

Choice type expanded with boolean choices with choices_as_values always preselects false value #17718

Choice type expanded with boolean choices with choices_as_values always preselects false value #17718

Comments

Choice type expanded with boolean choices with choices_as_values always preselects `false` value #17718

Choice type expanded with boolean choices with choices_as_values always preselects `false` value #17718