[Form] Add more concise signature to FormInterface::add() #5806

webmozart · 2012-10-22T07:52:10Z

Right now, the addition of fields in event listeners is quite complicated, because FormInterface does not support the same concise syntax for adding fields like FormBuilderInterface does:

<?php
$formFactory = $builder->getFormFactory();
$builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) use ($formFactory) {
    if (/* some condition */) {
        $event->getForm()->add($formFactory->createNamed('myfield', 'text'));
    } else {
        $event->getForm()->remove('myfield');
    }
});

This can be simplified by matching the signature of FormInterface::add() with FormBuilderInterface::add():

<?php
$builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {
    if (/* some condition */) {
        $event->getForm()->add('myfield', 'text');
    } else {
        $event->getForm()->remove('myfield');
    }
});

The method, like FormBuilderInterface::add(), would then support both signatures:

add($name, $type, array $options = array())
add(FormInterface $child)

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

mvrhov · 2012-10-22T08:16:39Z

I'm all 👍
The only problem with this is that PHP doesn't allow for method override. If you are going to use func_get_args then we are probably going to loose the IDE auto completion.

stof · 2012-10-22T08: 8000 19:49Z

@mvrhov the FormBuilder does not use func_get_args, simply an optional second argument

kadryjanek · 2012-10-27T20:16:04Z

I really like the idea 👍
@mvrhov there is no need of overriding methods just simply check the instance of the first argument and remove FormInterFace
requirement.
@bschussek you can also add FromInterfeace::addField method which would do the same as FormBuilderInterface::add(). Both solutions are better than creating fields in Event Listeners now.

addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) {
    if (/* some condition */) {
        $event->getForm()->addField('myfield', 'text');
        //$event->getForm()->add('myfield', 'text');
    } else {
        $event->getForm()->remove('myfield');
    }
});

@fabpot

This PR was merged into the master branch. Commits ------- 19d8510 [Form] Improved Form::add() and FormBuilder::add() to accept integers as field names fb71964 [Form] Added an alternative signature Form::add($name, $type, $options) Discussion ---------- [Form] Added an alternative signature Form::add($name, $type, $options) Bug fix: no Feature addition: yes Backwards compatibility break: no Symfony2 tests pass: yes Fixes the following tickets: #5806 Todo: - License of the code: MIT Documentation PR: symfony/symfony-docs#2024 --------------------------------------------------------------------------- by bschussek at 2012-12-18T10:42:55Z ping @fabpot

webmozart mentioned this issue Dec 14, 2012

[Form] Added an alternative signature Form::add($name, $type, $options) #6355

Merged

fabpot closed this as completed Dec 18, 2012

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Form] Add more concise signature to FormInterface::add() #5806

[Form] Add more concise signature to FormInterface::add() #5806

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[Form] Add more concise signature to FormInterface::add() #5806

[Form] Add more concise signature to FormInterface::add() #5806

Comments

Uh oh!

Uh oh!

Uh oh!