CurrencyType
class CurrencyType extends AbstractType implements ChoiceLoaderInterface
Methods
buildForm(FormBuilderInterface $builder, array $options) Builds the form. | from AbstractType | |
buildView(FormView $view, FormInterface $form, array $options) Builds the form view. | from AbstractType | |
finishView(FormView $view, FormInterface $form, array $options) Finishes the form view. | from AbstractType | |
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. | |
ChoiceListInterface | loadChoiceList(null|callable $value = null) Loads a list of choices. | |
array | loadChoicesForValues(array $values, null|callable $value = null) Loads the choices corresponding to the given values. | |
string[] | loadValuesForChoices(array $choices, null|callable $value = null) Loads the values corresponding to the given choices. |
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 |
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 |
ChoiceListInterface loadChoiceList(null|callable $value = null)
Loads a list of choices.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
null|callable | $value | The callable which generates the values from choices |
Return Value
ChoiceListInterface | The loaded choice list |
array loadChoicesForValues(array $values, null|callable $value = null)
Loads the choices corresponding to the given values.
The choices are returned with the same keys and in the same order as the corresponding values in the given array.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
array | $values | An array of choice values. Non-existing values in this array are ignored |
null|callable | $value | The callable generating the choice values |
Return Value
array | An array of choices |
string[] loadValuesForChoices(array $choices, null|callable $value = null)
Loads the values corresponding to the given choices.
The values are returned with the same keys and in the same order as the corresponding choices in the given array.
Optionally, a callable can be passed for generating the choice values. The callable receives the choice as first and the array key as the second argument.
Parameters
array | $choices | An array of choices. Non-existing choices in this array are ignored |
null|callable | $value | The callable generating the choice values |
Return Value
string[] | An array of choice values |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Form/Extension/Core/Type/CurrencyType.html