Repeated field type required is a required option

[kix]

The Symfony\Component\Form\Extension\Core\Type\RepeatedType throws Illegal string offset 'required' when a required option is not passed to the form builder. Could this be resolved via the OptionsResolverInterface::setRequired() method call in the RepeatedType::setDefaultOptions method?

[kix]

My exact usecase is this. The form type:

class UserType extends AbstractAPIType
{

    /**
     * @param FormBuilderInterface $builder
     * @param array                $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('email', 'email', [])
            ->add('username', 'text', [])
            ->add('password', 'repeated', [
                'type' => 'password',
                'required' => true,
                'first_options' => 'Password',
                'second_options' => 'Password (again)',
            ])
        ;
    }
}

...extending this simple wrapper

class AbstractAPIType extends AbstractType
{

    /**
     * Returns the name of this type.
     *
     * @return string The name of this type
     */
    final public function getName()
    {
        return '';
    }

    /**
     * @param OptionsResolverInterface $resolver
     */
    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
        $resolver
            ->setDefaults(['csrf_protection' => false])
        ;
    }
}

...throws an error in a test:

class UserTypeTest extends TypeTestCase
{
    public function testSubmitValidData()
    {
        $formData = [
            'email' => 'email@mail.com',
            'name'  => 'test user',
            'password' => '12345',
        ];

        $type = new UserType();
        $form = $this->factory->create($type);

        $form->submit($formData);
        $this->assertInstanceOf(User::class, $form->getData());

        $view = $form->createView();
        $children = $view->children;

        foreach (array_keys($formData) as $key) {
            $this->assertArrayHasKey($key, $children);
        }
    }
}

The trace and the error:

Illegal string offset 'required'

/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/Extension/Core/Type/RepeatedType.php:27
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/ResolvedFormType.php:140
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/FormFactory.php:91
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/FormBuilder.php:106
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/FormBuilder.php:271
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/FormBuilder.php:219
/Volumes/Storage/Users/kix/Sites/myproj/vendor/symfony/symfony/src/Symfony/Component/Form/FormFactory.php:39
/Volumes/Storage/Users/kix/Sites/myproj/src/MyProj/APIBundle/Tests/Form/UserTypeTest.php:38
/Users/kix/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:179
/Users/kix/.composer/vendor/phpunit/phpunit/src/TextUI/Command.php:132

[stof]

The required option has a default value for the repeated type, which is set by its parent type form. So this should not happen.
Are you registering a custom type in your application named form which would overwrite the core form type (which is the parent of all other types except buttons) ?

[kix]

@stof, no, there isn't any form type that would do this; I've also tried commenting out all of the non-standard bundles, the error is still there.
I've changed my UserType to extend Symfony\Component\Form\AbstractType, and it still fails; I'll try this once again against a clean Symfony install now (currently I'm on 2.5)

[kix]

@stof, well, it's actually a bit more funny: I've been passing the labels like this:

'first_options' => 'Password',

So the $options parameter passed into RepeatedType::buildForm is a string, and PHP treats it as an array while there's no way a string could have a string offset at this line.

Adding this into RepeatedType::setDefaultOptions resolves the issue:

$resolver->setAllowedTypes(array(
    'first_options' => 'array',
    'second_options' => 'array',
 ));

[kix]

I'll try to cover this with tests and issue a PR now, I think the issue is pretty obvious now.

[stof]

hmm, the right fix is indeed to add the allowed types for these 2 options to enforce passing an array

[kix]

This is resolved, no need to widen the scope I think.

[webmozart]

Fixed in #11696.