Add custom options to symfony form

Question

1 What i want to do is add custom (option is 'angular' in this case)option to my form widget template:

{%- block widget_attributes -%}
    id="{{ id }}" name="{{ full_name }}"

    {%- if angular %} ng-model="{{ full_name }}"{% endif -%}
 ....
    {%- if intention %} {{ intention }}{% endif -%}
    {%- if read_only %} readonly="readonly"{% endif -%}
 .....
{%- endblock widget_attributes -%}

I wand to decide about form has it option or no in my CustomFormType. But i can't achieve it. I tried different method.

Is it possible to add custom option to the main form?

I know that there are a lot of tutorials showing how to pass custom options in child element, e.g http://symfony.com/doc/current/cookbook/form/create_form_type_extension.html

I investigated core of form component and there are class

 namespace Symfony\Component\Form\Extension\Core\Type;

 class FormType extends BaseType{}

which has method build View

public function buildView(FormView $view, FormInterface $form, array $options)
{

     .....

    $view->vars = array_replace($view->vars, array(
        'read_only' => $readOnly,
        'errors' => $form->getErrors(),
        'valid' => $form->isSubmitted() ? $form->isValid() : true,
        'value' => $form->getViewData(),
        'data' => $form->getNormData(),
        'required' => $form->isRequired(),
        'max_length' => isset($options['attr']['maxlength']) ? $options['attr']['maxlength'] : null, // Deprecated
        'pattern' => isset($options['attr']['pattern']) ? $options['attr']['pattern'] : null, // Deprecated
        'size' => null,
        'label_attr' => $options['label_attr'],
        'compound' => $form->getConfig()->getCompound(),
        'method' => $form->getConfig()->getMethod(),
        'action' => $form->getConfig()->getAction(),
        'submitted' => $form->isSubmitted(),

    ));
}

Above symfony define base options. I can access these options globally in form template, but i can't find the way to add my own.

Charlie Lucas · Accepted Answer · 2015-04-02 12:00:32Z

15

Simply add default option in you form type

/**
 * @param OptionsResolverInterface $resolver
 */
public function setDefaultOptions(OptionsResolverInterface $resolver)
{
    $resolver->setDefaults(array(
        // default form options
        'my_options' => 'my default value option'
    ));
}

EDIT

/**
 * {@inheritdoc}
 */
public function buildView(FormView $view, FormInterface $form, array $options)
{
    $view->vars['my_options'] = $options['my_options'];
}

edited Apr 2, 2015 at 12:00

answered Apr 2, 2015 at 10:26

Charlie Lucas

2901 silver badge10 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Piotr Galas Over a year ago

Thank you for answer but this allow me to add option to formType object. I canot access this option in my twig template. I need to pass option to FormView object. We put $formType->createView from controller to view

Piotr Galas · Accepted Answer · 2015-04-03 12:16:20Z

I found solution based on @Charlie Lucas post.

public function buildView(FormView $view, FormInterface $form, array $options)
{
    $view->vars['my_options'] = $options['my_options'];
}

above method update only parent form (I ask about it), but if i pass this options in widget template:

{%- block widget_attributes -%}
 {{ 'my_options' }}
{%- endblock widget_attributes -%}

I recive errorr that the option doesnt exist.

Now I understand why error occured. This option is invoked in every widget. That mean that also child element invoke this option. But this option is not defined in children.

To solve it I add option to parent form and to child form in FormType class. In

  public function buildView(FormView $view, FormInterface $form, array $options)
 {
    .....
 }

We have no access to child element so I had to invoke finishView() instead. In this method i use recurence function to add option to all element

public function finishView(FormView $view, FormInterface $form, array $options)
{
    $params = array(
        'angular'=>true,
    );

    $this->setParam( $view, $params);

}

private function setParam(FormView $view, array $params)
{
    $this->updateParam($view, $params);
    $this->updateChild($view, $params);
}

private function updateChild(FormView $parent, array $params)
{
    foreach ($parent->children as $child){
        $this->updateParam($child, $params);
        $this->updateChild($child, $params);
    }
}

private function updateParam(FormView $view, array $params)
{
    foreach($params as $key => $value){
        $view->vars[$key] = $value;
    }
}

krzysztof · Accepted Answer · 2021-11-17 09:45:25Z

2

In symfony 5

public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
        'my_custom_option' => 'default_value',
        'data_class' => User::class,
    ]);
}

answered Nov 17, 2021 at 9:45

krzysztof

4414 silver badges3 bronze badges

Collectives™ on Stack Overflow

Add custom options to symfony form

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related