Symfony2 API
Class

Symfony\Component\Form\Extension\Core\Type\CheckboxType

class CheckboxType extends AbstractType

Methods

buildForm(FormBuilderInterface $builder, array $options)

Builds the form.

buildView(FormView $view, FormInterface $form, array $options)

Builds the form view.

finishView(FormView $view, FormInterface $form, array $options)

Finishes the form view.

from AbstractType
setDefaultOptions(OptionsResolverInterface $resolver)

Sets the default options for this type.

string|null|FormTypeInterface getParent()

Returns the name of the parent type.

from AbstractType
string getName()

Returns the name of this type.

Details

at line 26
public buildForm(FormBuilderInterface $builder, array $options)

Builds the form.

This method is called for each type in the hierarchy starting from the top most type. Type extensions can further modify the form.

Parameters

FormBuilderInterface $builder The form builder
array $options The options

at line 41
public buildView(FormView $view, FormInterface $form, array $options)

Builds the form view.

This method is called for each type in the hierarchy starting from the top most type. Type extensions can further modify the view.

A view of a form is built before the views of the child forms are built. This means that you cannot access child views in this method. If you need to do so, move your logic to {@link finishView()} instead.

Parameters

FormView $view The view
FormInterface $form The form
array $options The options

in AbstractType at line 38
public finishView(FormView $view, FormInterface $form, array $options)

Finishes the form view.

This method gets called for each type in the hierarchy starting from the top most type. Type extensions can further modify the view.

When this method is called, views of the form's children have already been built and finished and can be accessed. You should only implement such logic in this method that actually accesses child views. For everything else you are recommended to implement {@link buildView()} instead.

Parameters

FormView $view The view
FormInterface $form The form
array $options The options

at line 52
public setDefaultOptions(OptionsResolverInterface $resolver)

Sets the default options for this type.

Parameters

OptionsResolverInterface $resolver The resolver for the options.

in AbstractType at line 52
public string|null|FormTypeInterface getParent()

Returns the name of the parent type.

You can also return a type instance from this method, although doing so is discouraged because it leads to a performance penalty. The support for returning type instances may be dropped from future releases.

Return Value

string|null|FormTypeInterface The name of the parent type if any, null otherwise.

at line 68
public string getName()

Returns the name of this type.

Return Value

string The name of this type