Symfony2 API
Interface

Symfony\Component\Form\FormBuilderInterface

interface FormBuilderInterface implements Traversable, Countable, FormConfigBuilderInterface

Methods

FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, integer $priority)

Adds an event listener to an event on this form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber for events on this form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, Boolean $forcePrepend = false)

Appends / prepends a transformer to the view transformer chain.

 from FormConfigBuilderInterface
FormConfigBuilderInterface resetViewTransformers()

Clears the view transformers.

 from FormConfigBuilderInterface
FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, Boolean $forceAppend = false)

Prepends / appends a transformer to the normalization transformer chain.

 from FormConfigBuilderInterface
FormConfigBuilderInterface resetModelTransformers()

Clears the normalization transformers.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setAttribute(string $name, string $value)

Sets the value for an attribute.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setDisabled(Boolean $disabled)

Set whether the form is disabled.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setEmptyData(mixed $emptyData)

Sets the data used for the client data when no value is submitted.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setErrorBubbling(Boolean $errorBubbling)

Sets whether errors bubble up to the parent.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setRequired(Boolean $required)

Sets whether this field is required to be filled out when submitted.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Sets the property path that the form should be mapped to.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setMapped(Boolean $mapped)

Sets whether the form should be mapped to an element of its parent's data.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setByReference(Boolean $byReference)

Sets whether the form's data should be modified by reference.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setInheritData(Boolean $inheritData)

Sets whether the form should read and write the data of its parent.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setCompound(Boolean $compound)

Sets whether the form should be compound.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Set the types.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setData(array $data)

Sets the initial data of the form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setDataLocked(Boolean $locked)

Locks the form's data to the data passed in the configuration.

 from FormConfigBuilderInterface
setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setAction(string $action)

Sets the target URL of the form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setMethod(string $method)

Sets the HTTP method used by the form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

 from FormConfigBuilderInterface
FormConfigBuilderInterface setAutoInitialize(Boolean $initialize)

Sets whether the form should be initialized automatically.

 from FormConfigBuilderInterface
FormConfigInterface getFormConfig()

Builds and returns the form configuration.

 from FormConfigBuilderInterface
FormBuilderInterface add(string|integer|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array())

Adds a new field to this group.
FormBuilderInterface create(string $name, string|FormTypeInterface $type = null, array $options = array())

Creates a form builder.
FormBuilderInterface get(string $name)

Returns a child by name.
FormBuilderInterface remove(string $name)

Removes the field with the given name.
Boolean has(string $name)

Returns whether a field with the given name exists.
array all()

Returns the children.
Form getForm()

Creates the form.

Details

in FormConfigBuilderInterface at line 32
public FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, integer $priority)

Adds an event listener to an event on this form.

Parameters

string $eventName The name of the event to listen to.
callable $listener The listener to execute.
integer $priority The priority of the listener. Listeners with a higher priority are called before listeners with a lower priority.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 41
public FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber for events on this form.

Parameters

EventSubscriberInterface $subscriber The subscriber to attach.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 56
public FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, Boolean $forcePrepend = false)

Appends / prepends a transformer to the view transformer chain.

The transform method of the transformer is used to convert data from the
normalized to the view format.
The reverseTransform method of the transformer is used to convert from the
view to the normalized format.

Parameters

DataTransformerInterface $viewTransformer
Boolean $forcePrepend if set to true, prepend instead of appending

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 63
public FormConfigBuilderInterface resetViewTransformers()

Clears the view transformers.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 78
public FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, Boolean $forceAppend = false)

Prepends / appends a transformer to the normalization transformer chain.

The transform method of the transformer is used to convert data from the
model to the normalized format.
The reverseTransform method of the transformer is used to convert from the
normalized to the model format.

Parameters

DataTransformerInterface $modelTransformer
Boolean $forceAppend if set to true, append instead of prepending

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 85
public FormConfigBuilderInterface resetModelTransformers()

Clears the normalization transformers.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 95
public FormConfigBuilderInterface setAttribute(string $name, string $value)

Sets the value for an attribute.

Parameters

string $name The name of the attribute
string $value The value of the attribute

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 104
public FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 113
public FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

Parameters

DataMapperInterface $dataMapper

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 122
public FormConfigBuilderInterface setDisabled(Boolean $disabled)

Set whether the form is disabled.

Parameters

Boolean $disabled Whether the form is disabled

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 131
public FormConfigBuilderInterface setEmptyData(mixed $emptyData)

Sets the data used for the client data when no value is submitted.

Parameters

mixed $emptyData The empty data.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 140
public FormConfigBuilderInterface setErrorBubbling(Boolean $errorBubbling)

Sets whether errors bubble up to the parent.

Parameters

Boolean $errorBubbling

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 149
public FormConfigBuilderInterface setRequired(Boolean $required)

Sets whether this field is required to be filled out when submitted.

Parameters

Boolean $required

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 160
public FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Sets the property path that the form should be mapped to.

Parameters

null|string|PropertyPathInterface $propertyPath The property path or null if the path should be set automatically based on the form's name.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 170
public FormConfigBuilderInterface setMapped(Boolean $mapped)

Sets whether the form should be mapped to an element of its parent's data.

Parameters

Boolean $mapped Whether the form should be mapped.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 180
public FormConfigBuilderInterface setByReference(Boolean $byReference)

Sets whether the form's data should be modified by reference.

Parameters

Boolean $byReference Whether the data should be modified by reference.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 189
public FormConfigBuilderInterface setInheritData(Boolean $inheritData)

Sets whether the form should read and write the data of its parent.

Parameters

Boolean $inheritData Whether the form should inherit its parent's data.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 200
public FormConfigBuilderInterface setCompound(Boolean $compound)

Sets whether the form should be compound.

Parameters

Boolean $compound Whether the form should be compound.

Return Value

FormConfigBuilderInterface The configuration object.

See also

FormConfigInterface::getCompound()

in FormConfigBuilderInterface at line 209
public FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Set the types.

Parameters

ResolvedFormTypeInterface $type The type of the form.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 218
public FormConfigBuilderInterface setData(array $data)

Sets the initial data of the form.

Parameters

array $data The data of the form in application format.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 231
public FormConfigBuilderInterface setDataLocked(Boolean $locked)

Locks the form's data to the data passed in the configuration.

A form with locked data is restricted to the data passed in
this configuration. The data can only be modified then by
submitting the form.

Parameters

Boolean $locked Whether to lock the default data.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 238
public setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

Parameters

FormFactoryInterface $formFactory The form factory.

in FormConfigBuilderInterface at line 247
public FormConfigBuilderInterface setAction(string $action)

Sets the target URL of the form.

Parameters

string $action The target URL of the form.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 256
public FormConfigBuilderInterface setMethod(string $method)

Sets the HTTP method used by the form.

Parameters

string $method The HTTP method of the form.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 265
public FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

Parameters

RequestHandlerInterface $requestHandler

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 279
public FormConfigBuilderInterface setAutoInitialize(Boolean $initialize)

Sets whether the form should be initialized automatically.

Should be set to true only for root forms.

Parameters

Boolean $initialize True to initialize the form automatically, false to suppress automatic initialization. In the second case, you need to call {@link FormInterface::initialize()} manually.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line 286
public FormConfigInterface getFormConfig()

Builds and returns the form configuration.

Return Value

FormConfigInterface

at line 32
public FormBuilderInterface add(string|integer|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array())

Adds a new field to this group.

A field must have a unique name within
the group. Otherwise the existing field is overwritten.

If you add a nested group, this group should also be represented in the
object hierarchy.

Parameters

string|integer|FormBuilderInterface $child
string|FormTypeInterface $type
array $options

Return Value

FormBuilderInterface The builder object.

at line 43
public FormBuilderInterface create(string $name, string|FormTypeInterface $type = null, array $options = array())

Creates a form builder.

Parameters

string $name The name of the form or the name of the property
string|FormTypeInterface $type The type of the form or null if name is a property
array $options The options

Return Value

FormBuilderInterface The created builder.

at line 54
public FormBuilderInterface get(string $name)

Returns a child by name.

Parameters

string $name The name of the child

Return Value

FormBuilderInterface The builder for the child

Exceptions

InvalidArgumentException if the given child does not exist

at line 63
public FormBuilderInterface remove(string $name)

Removes the field with the given name.

Parameters

string $name

Return Value

FormBuilderInterface The builder object.

at line 72
public Boolean has(string $name)

Returns whether a field with the given name exists.

Parameters

string $name

Return Value

Boolean

at line 79
public array all()

Returns the children.

Return Value

array

at line 86
public Form getForm()

Creates the form.

Return Value

Form The form