interface ButtonTypeInterface implements FormTypeInterface

A type that should be converted into a {@link Button} instance.

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.

setDefaultOptions(OptionsResolverInterface $resolver) deprecated

Sets the default options for this type.

string|FormTypeInterface|null
getParent()

Returns the name of the parent type.

string
getName() deprecated

Returns the name of this type.

Details

in FormTypeInterface at line 32
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

See also

FormTypeExtensionInterface::buildForm

in FormTypeInterface at line 50
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

See also

FormTypeExtensionInterface::buildView

in FormTypeInterface at line 69
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

See also

FormTypeExtensionInterface::finishView

in FormTypeInterface at line 80
setDefaultOptions(OptionsResolverInterface $resolver) deprecated

deprecated since version 2.7, to be renamed in 3.0. Use the method configureOptions instead. This method will be added to the FormTypeInterface with Symfony 3.0.

Sets the default options for this type.

Parameters

OptionsResolverInterface $resolver The resolver for the options

in FormTypeInterface at line 95
string|FormTypeInterface|null 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.

Returning a {@link FormTypeInterface} instance is deprecated since Symfony 2.8 and will be unsupported as of Symfony 3.0. Return the fully-qualified class name of the parent type instead.

Return Value

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

in FormTypeInterface at line 105
string getName() deprecated

deprecated Deprecated since Symfony 2.8, to be removed in Symfony 3.0. Use the fully-qualified class name of the type instead.

Returns the name of this type.

Return Value

string The name of this type