DoctrineType
DoctrineType
class DoctrineType extends AbstractType
Methods
buildForm(FormBuilderInterface $builder, array $options) Builds the form. | ||
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 | |
setDefaultOptions(OptionsResolverInterface $resolver) Sets the default options for this type. | from AbstractType | |
configureOptions(OptionsResolver $resolver) Configures the options for this type. | ||
string|null|FormTypeInterface | getParent() Returns the name of the parent type. | |
static string | createChoiceLabel(object $choice) Creates the label for a choice. | |
static string | createChoiceName(object $choice, int|string $key, string $value) Creates the field name for a choice. | |
array|false | getQueryBuilderPartsForCachingHash(object $queryBuilder) Gets important parts from QueryBuilder that will allow to cache its results. | |
__construct(ManagerRegistry $registry, PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null) | ||
EntityLoaderInterface | getLoader(ObjectManager $manager, mixed $queryBuilder, string $class) Return the default loader object. |
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|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.
Return Value
string|null|FormTypeInterface | The name of the parent type if any, null otherwise |
static string createChoiceLabel(object $choice)
Creates the label for a choice.
For backwards compatibility, objects are cast to strings by default.
Parameters
object | $choice | The object |
Return Value
string | The string representation of the object |
static string createChoiceName(object $choice, int|string $key, string $value)
Creates the field name for a choice.
This method is used to generate field names if the underlying object has a single-column integer ID. In that case, the value of the field is the ID of the object. That ID is also used as field name.
Parameters
object | $choice | The object |
int|string | $key | The choice key |
string | $value | The choice value. Corresponds to the object's ID here. |
Return Value
string | The field name |
array|false getQueryBuilderPartsForCachingHash(object $queryBuilder)
Gets important parts from QueryBuilder that will allow to cache its results.
For instance in ORM two query builders with an equal SQL string and equal parameters are considered to be equal.
Parameters
object | $queryBuilder |
Return Value
array|false | Array with important QueryBuilder parts or false if they can't be determined |
__construct(ManagerRegistry $registry, PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)
Parameters
ManagerRegistry | $registry | |
PropertyAccessorInterface | $propertyAccessor | |
ChoiceListFactoryInterface | $choiceListFactory |
abstract EntityLoaderInterface getLoader(ObjectManager $manager, mixed $queryBuilder, string $class)
Return the default loader object.
Parameters
ObjectManager | $manager | |
mixed | $queryBuilder | |
string | $class |
Return Value
EntityLoaderInterface |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Bridge/Doctrine/Form/Type/DoctrineType.html