interface FormBuilderInterface implements Traversable, Countable, FormConfigBuilderInterface

Methods

getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

string
getName()

Returns the name of the form used as HTTP parameter.

getPropertyPath()

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

Boolean
getMapped()

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

Boolean
getByReference()

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

Boolean
getInheritData()

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

Boolean
getCompound()

Returns whether the form is compound.

getType()

Returns the form types used to construct the form.

getViewTransformers()

Returns the view transformers of the form.

getModelTransformers()

Returns the model transformers of the form.

getDataMapper()

Returns the data mapper of the form.

Boolean
getRequired()

Returns whether the form is required.

Boolean
getDisabled()

Returns whether the form is disabled.

Boolean
getErrorBubbling()

Returns whether errors attached to the form will bubble to its parent.

mixed
getEmptyData()

Returns the data that should be returned when the form is empty.

array
getAttributes()

Returns additional attributes of the form.

Boolean
hasAttribute(string $name)

Returns whether the attribute with the given name exists.

mixed
getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.

mixed
getData()

Returns the initial data of the form.

string
getDataClass()

Returns the class of the form data or null if the data is scalar or an array.

Boolean
getDataLocked()

Returns whether the form's data is locked.

getFormFactory()

Returns the form factory used for creating new forms.

string
getAction()

Returns the target URL of the form.

string
getMethod()

Returns the HTTP method used by the form.

getRequestHandler()

Returns the request handler used by the form.

Boolean
getAutoInitialize()

Returns whether the form should be initialized upon creation.

array
getOptions()

Returns all options passed during the construction of the form.

Boolean
hasOption(string $name)

Returns whether a specific option exists.

mixed
getOption(string $name, mixed $default = null)

Returns the value of a specific option.

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

Adds an event listener to an event on this form.

addEventSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber for events on this form.

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

Appends / prepends a transformer to the view transformer chain.

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

Prepends / appends a transformer to the normalization transformer chain.

resetModelTransformers()

Clears the normalization transformers.

setAttribute(string $name, string $value)

Sets the value for an attribute.

setAttributes(array $attributes)

Sets the attributes.

setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

setDisabled(Boolean $disabled)

Set whether the form is disabled.

setEmptyData(mixed $emptyData)

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

setErrorBubbling(Boolean $errorBubbling)

Sets whether errors bubble up to the parent.

setRequired(Boolean $required)

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

setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

setMapped(Boolean $mapped)

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

setByReference(Boolean $byReference)

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

setInheritData(Boolean $inheritData)

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

setCompound(Boolean $compound)

Sets whether the form should be compound.

setData(array $data)

Sets the initial data of the form.

setDataLocked(Boolean $locked)

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

setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

setAction(string $action)

Sets the target URL of the form.

setMethod(string $method)

Sets the HTTP method used by the form.

setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

setAutoInitialize(Boolean $initialize)

Sets whether the form should be initialized automatically.

getFormConfig()

Builds and returns the form configuration.

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.

create(string $name, string|FormTypeInterface $type = null, array $options = array())

Creates a form builder.

get(string $name)

Returns a child by name.

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.

getForm()

Creates the form.

Details

in FormConfigInterface at line line 26
EventDispatcherInterface getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

Return Value

EventDispatcherInterface The dispatcher.

in FormConfigInterface at line line 33
string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name.

in FormConfigInterface at line line 40
null|PropertyPathInterface getPropertyPath()

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

Return Value

null|PropertyPathInterface The property path.

in FormConfigInterface at line line 48
Boolean getMapped()

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

Return Value

Boolean Whether the form is mapped.

in FormConfigInterface at line line 55
Boolean getByReference()

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

Return Value

Boolean Whether to modify the form's data by reference.

in FormConfigInterface at line line 62
Boolean getInheritData()

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

Return Value

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

in FormConfigInterface at line line 73
Boolean getCompound()

Returns whether the form is compound.

This property is independent of whether the form actually has children. A form can be compound and have no children at all, like for example an empty collection form.

Return Value

Boolean Whether the form is compound.

in FormConfigInterface at line line 80
ResolvedFormTypeInterface getType()

Returns the form types used to construct the form.

Return Value

ResolvedFormTypeInterface The form's type.

in FormConfigInterface at line line 87
DataTransformerInterface[] getViewTransformers()

Returns the view transformers of the form.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances.

in FormConfigInterface at line line 94
DataTransformerInterface[] getModelTransformers()

Returns the model transformers of the form.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances.

in FormConfigInterface at line line 101
DataMapperInterface getDataMapper()

Returns the data mapper of the form.

Return Value

DataMapperInterface The data mapper.

in FormConfigInterface at line line 108
Boolean getRequired()

Returns whether the form is required.

Return Value

Boolean Whether the form is required.

in FormConfigInterface at line line 115
Boolean getDisabled()

Returns whether the form is disabled.

Return Value

Boolean Whether the form is disabled.

in FormConfigInterface at line line 122
Boolean getErrorBubbling()

Returns whether errors attached to the form will bubble to its parent.

Return Value

Boolean Whether errors will bubble up.

in FormConfigInterface at line line 129
mixed getEmptyData()

Returns the data that should be returned when the form is empty.

Return Value

mixed The data returned if the form is empty.

in FormConfigInterface at line line 136
array getAttributes()

Returns additional attributes of the form.

Return Value

array An array of key-value combinations.

in FormConfigInterface at line line 145
Boolean hasAttribute(string $name)

Returns whether the attribute with the given name exists.

Parameters

string $name The attribute name.

Return Value

Boolean Whether the attribute exists.

in FormConfigInterface at line line 155
mixed getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.

Parameters

string $name The attribute name.
mixed $default The value returned if the attribute does not exist.

Return Value

mixed The attribute value.

in FormConfigInterface at line line 162
mixed getData()

Returns the initial data of the form.

Return Value

mixed The initial form data.

in FormConfigInterface at line line 169
string getDataClass()

Returns the class of the form data or null if the data is scalar or an array.

Return Value

string The data class or null.

in FormConfigInterface at line line 180
Boolean getDataLocked()

Returns whether the form's data is locked.

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.

Return Value

Boolean Whether the data is locked.

in FormConfigInterface at line line 187
FormFactoryInterface getFormFactory()

Returns the form factory used for creating new forms.

Return Value

FormFactoryInterface The form factory.

in FormConfigInterface at line line 194
string getAction()

Returns the target URL of the form.

Return Value

string The target URL of the form.

in FormConfigInterface at line line 201
string getMethod()

Returns the HTTP method used by the form.

Return Value

string The HTTP method of the form.

in FormConfigInterface at line line 208
RequestHandlerInterface getRequestHandler()

Returns the request handler used by the form.

Return Value

RequestHandlerInterface The request handler.

in FormConfigInterface at line line 216
Boolean getAutoInitialize()

Returns whether the form should be initialized upon creation.

Return Value

Boolean Returns true if the form should be initialized when created, false otherwise.

in FormConfigInterface at line line 223
array getOptions()

Returns all options passed during the construction of the form.

Return Value

array The passed options.

in FormConfigInterface at line line 232
Boolean hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

Boolean Whether the option exists.

in FormConfigInterface at line line 242
mixed getOption(string $name, mixed $default = null)

Returns the value of a specific option.

Parameters

string $name The option name.
mixed $default The value returned if the option does not exist.

Return Value

mixed The option value.

in FormConfigBuilderInterface at line line 32
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 line 41
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 line 56
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 line 63
FormConfigBuilderInterface resetViewTransformers()

Clears the view transformers.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line line 78
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 line 85
FormConfigBuilderInterface resetModelTransformers()

Clears the normalization transformers.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line line 95
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 line 104
FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes.

Return Value

FormConfigBuilderInterface The configuration object.

in FormConfigBuilderInterface at line line 113
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 line 122
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 line 131
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 line 140
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 line 149
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 line 160
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 line 170
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 line 180
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 line 189
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 line 200
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 line 209
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 line 218
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 line 231
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 line 238
setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

Parameters

FormFactoryInterface $formFactory The form factory.

in FormConfigBuilderInterface at line line 247
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 line 256
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 line 265
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 line 279
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 line 286
FormConfigInterface getFormConfig()

Builds and returns the form configuration.

Return Value

FormConfigInterface

at line line 32
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 line 43
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 line 54
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 line 63
FormBuilderInterface remove(string $name)

Removes the field with the given name.

Parameters

string $name

Return Value

FormBuilderInterface The builder object.

at line line 72
Boolean has(string $name)

Returns whether a field with the given name exists.

Parameters

string $name

Return Value

Boolean

at line line 79
array all()

Returns the children.

Return Value

array

at line line 86
Form getForm()

Creates the form.

Return Value

Form The form