FormTypeInterface

interface FormTypeInterface

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.

configureOptions(OptionsResolver $resolver)

Configures the options for this type.

string getBlockPrefix()

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

string|null getParent()

Returns the name of the parent type.

Details

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()

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()

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()

configureOptions(OptionsResolver $resolver)

Configures the options for this type.

Parameters

OptionsResolver $resolver The resolver for the options

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 The prefix of the template block name

string|null getParent()

Returns the name of the parent type.

Return Value

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Form/FormTypeInterface.html