AbstractType
class AbstractType implements 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. | ||
setDefaultOptions(OptionsResolverInterface $resolver) Sets the default options for this type. | ||
configureOptions(OptionsResolver $resolver) Configures the options for this type. | ||
string | getName() Returns the name of this type. | |
string | getBlockPrefix() Returns the prefix of the template block name for this type. | |
string|null|FormTypeInterface | 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 |
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 |
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 |
setDefaultOptions(OptionsResolverInterface $resolver)
Sets the default options for this type.
Parameters
OptionsResolverInterface | $resolver | The resolver for the options |
configureOptions(OptionsResolver $resolver)
Configures the options for this type.
Parameters
OptionsResolver | $resolver | The resolver for the options |
string getName()
Returns the name of this type.
Return Value
string | The name of this type |
string getBlockPrefix()
Returns the prefix of the template block name for this type.
The block prefixes default 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|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.
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|null|FormTypeInterface | The name of the parent type if any, null otherwise |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Form/AbstractType.html