interface ButtonTypeInterface implementsFormTypeInterface

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

Methods

string|null
getParent()

Returns the name of the parent type.

void
configureOptions(OptionsResolver$resolver)

Configures the options for this type.

void
buildForm(FormBuilderInterface$builder,array$options)

Builds the form.

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

Builds the form view.

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

Finishes the form view.

string
getBlockPrefix()

Returns the prefix of the template block name for this type.

Details

string|null getParent()

Returns the name of the parent type.

The parent type and its extensions will configure the form with the following methods before the current implementation.

Return Value

string|null

void configureOptions(OptionsResolver$resolver)

Configures the options for this type.

Parameters

OptionsResolver $resolver

Return Value

void

void 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
array $options

Return Value

void

See also

FormTypeExtensionInterface::buildForm

void 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
FormInterface $form
array $options

Return Value

void

See also

FormTypeExtensionInterface::buildView

void 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
FormInterface $form
array $options

Return Value

void

See also

FormTypeExtensionInterface::finishView

string getBlockPrefix()

Returns the prefix of the template block name for this type.

The block prefix defaults to the underscored short class name with the "Type" suffix removed (e.g. "UserProfileType" => "user_profile").

Return Value

string