Symfony2 API
Interface

Symfony\Component\Form\FormBuilderInterface

interface FormBuilderInterface implements Traversable, Countable, FormConfigBuilderInterface

Methods

EventDispatcherInterface getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

from FormConfigInterface
string getName()

Returns the name of the form used as HTTP parameter.

from FormConfigInterface
null|PropertyPathInterface getPropertyPath()

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

from FormConfigInterface
bool getMapped()

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

from FormConfigInterface
bool getByReference()

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

from FormConfigInterface
bool getInheritData()

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

from FormConfigInterface
bool getCompound()

Returns whether the form is compound.

from FormConfigInterface
ResolvedFormTypeInterface getType()

Returns the form types used to construct the form.

from FormConfigInterface
DataTransformerInterface[] getViewTransformers()

Returns the view transformers of the form.

from FormConfigInterface
DataTransformerInterface[] getModelTransformers()

Returns the model transformers of the form.

from FormConfigInterface
DataMapperInterface getDataMapper()

Returns the data mapper of the form.

from FormConfigInterface
bool getRequired()

Returns whether the form is required.

from FormConfigInterface
bool getDisabled()

Returns whether the form is disabled.

from FormConfigInterface
bool getErrorBubbling()

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

from FormConfigInterface
mixed getEmptyData()

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

from FormConfigInterface
array getAttributes()

Returns additional attributes of the form.

from FormConfigInterface
bool hasAttribute(string $name)

Returns whether the attribute with the given name exists.

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

Returns the value of the given attribute.

from FormConfigInterface
mixed getData()

Returns the initial data of the form.

from FormConfigInterface
string getDataClass()

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

from FormConfigInterface
bool getDataLocked()

Returns whether the form's data is locked.

from FormConfigInterface
FormFactoryInterface getFormFactory()

Returns the form factory used for creating new forms.

from FormConfigInterface
string getAction()

Returns the target URL of the form.

from FormConfigInterface
string getMethod()

Returns the HTTP method used by the form.

from FormConfigInterface
RequestHandlerInterface getRequestHandler()

Returns the request handler used by the form.

from FormConfigInterface
bool getAutoInitialize()

Returns whether the form should be initialized upon creation.

from FormConfigInterface
array getOptions()

Returns all options passed during the construction of the form.

from FormConfigInterface
bool hasOption(string $name)

Returns whether a specific option exists.

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

Returns the value of a specific option.

from FormConfigInterface
FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $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, bool $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, bool $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, mixed $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(bool $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(bool $errorBubbling)

Sets whether errors bubble up to the parent.

from FormConfigBuilderInterface
FormConfigBuilderInterface setRequired(bool $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(bool $mapped)

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

from FormConfigBuilderInterface
FormConfigBuilderInterface setByReference(bool $byReference)

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

from FormConfigBuilderInterface
FormConfigBuilderInterface setInheritData(bool $inheritData)

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

from FormConfigBuilderInterface
FormConfigBuilderInterface setCompound(bool $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(bool $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(bool $initialize)

Sets whether the form should be initialized automatically.

from FormConfigBuilderInterface
FormConfigInterface getFormConfig()

Builds and returns the form configuration.

from FormConfigBuilderInterface
FormBuilderInterface add(string|int|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.

bool has(string $name)

Returns whether a field with the given name exists.

array all()

Returns the children.

Form getForm()

Creates the form.

Details

in FormConfigInterface at line 29
public EventDispatcherInterface getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

Return Value

EventDispatcherInterface The dispatcher.

in FormConfigInterface at line 36
public string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name.

in FormConfigInterface at line 43
public 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 51
public bool getMapped()

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

Return Value

bool Whether the form is mapped.

in FormConfigInterface at line 58
public bool getByReference()

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

Return Value

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

in FormConfigInterface at line 65
public bool getInheritData()

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

Return Value

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

in FormConfigInterface at line 76
public bool 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

bool Whether the form is compound.

in FormConfigInterface at line 83
public ResolvedFormTypeInterface getType()

Returns the form types used to construct the form.

Return Value

ResolvedFormTypeInterface The form's type.

in FormConfigInterface at line 90
public DataTransformerInterface[] getViewTransformers()

Returns the view transformers of the form.

Return Value

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

in FormConfigInterface at line 97
public DataTransformerInterface[] getModelTransformers()

Returns the model transformers of the form.

Return Value

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

in FormConfigInterface at line 104
public DataMapperInterface getDataMapper()

Returns the data mapper of the form.

Return Value

DataMapperInterface The data mapper.

in FormConfigInterface at line 111
public bool getRequired()

Returns whether the form is required.

Return Value

bool Whether the form is required.

in FormConfigInterface at line 118
public bool getDisabled()

Returns whether the form is disabled.

Return Value

bool Whether the form is disabled.

in FormConfigInterface at line 125
public bool getErrorBubbling()

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

Return Value

bool Whether errors will bubble up.

in FormConfigInterface at line 132
public 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 139
public array getAttributes()

Returns additional attributes of the form.

Return Value

array An array of key-value combinations.

in FormConfigInterface at line 148
public bool hasAttribute(string $name)

Returns whether the attribute with the given name exists.

Parameters

string $name The attribute name.

Return Value

bool Whether the attribute exists.

in FormConfigInterface at line 158
public 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 165
public mixed getData()

Returns the initial data of the form.

Return Value

mixed The initial form data.

in FormConfigInterface at line 172
public 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 183
public bool 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

bool Whether the data is locked.

in FormConfigInterface at line 190
public FormFactoryInterface getFormFactory()

Returns the form factory used for creating new forms.

Return Value

FormFactoryInterface The form factory.

in FormConfigInterface at line 197
public string getAction()

Returns the target URL of the form.

Return Value

string The target URL of the form.

in FormConfigInterface at line 204
public string getMethod()

Returns the HTTP method used by the form.

Return Value

string The HTTP method of the form.

in FormConfigInterface at line 211
public RequestHandlerInterface getRequestHandler()

Returns the request handler used by the form.

Return Value

RequestHandlerInterface The request handler.

in FormConfigInterface at line 219
public bool getAutoInitialize()

Returns whether the form should be initialized upon creation.

Return Value

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

in FormConfigInterface at line 226
public array getOptions()

Returns all options passed during the construction of the form.

Return Value

array The passed options.

in FormConfigInterface at line 235
public bool hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

bool Whether the option exists.

in FormConfigInterface at line 245
public 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.

public FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $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.
int $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.

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.

public FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, bool $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
bool $forcePrepend if set to true, prepend instead of appending

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface resetViewTransformers()

Clears the view transformers.

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, bool $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
bool $forceAppend if set to true, append instead of prepending

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface resetModelTransformers()

Clears the normalization transformers.

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setAttribute(string $name, mixed $value)

Sets the value for an attribute.

Parameters

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

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes.

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

Parameters

DataMapperInterface $dataMapper

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setDisabled(bool $disabled)

Set whether the form is disabled.

Parameters

bool $disabled Whether the form is disabled

Return Value

FormConfigBuilderInterface The configuration object.

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.

public FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

Sets whether errors bubble up to the parent.

Parameters

bool $errorBubbling

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setRequired(bool $required)

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

Parameters

bool $required

Return Value

FormConfigBuilderInterface The configuration object.

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.

public FormConfigBuilderInterface setMapped(bool $mapped)

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

Parameters

bool $mapped Whether the form should be mapped.

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setByReference(bool $byReference)

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

Parameters

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

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Parameters

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

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setCompound(bool $compound)

Sets whether the form should be compound.

Parameters

bool $compound Whether the form should be compound.

Return Value

FormConfigBuilderInterface The configuration object.

See also

FormConfigInterface::getCompound()

public FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Set the types.

Parameters

ResolvedFormTypeInterface $type The type of the form.

Return Value

FormConfigBuilderInterface The configuration object.

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.

public FormConfigBuilderInterface setDataLocked(bool $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

bool $locked Whether to lock the default data.

Return Value

FormConfigBuilderInterface The configuration object.

public setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

Parameters

FormFactoryInterface $formFactory The form factory.

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.

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.

public FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

Parameters

RequestHandlerInterface $requestHandler

Return Value

FormConfigBuilderInterface The configuration object.

public FormConfigBuilderInterface setAutoInitialize(bool $initialize)

Sets whether the form should be initialized automatically.

Should be set to true only for root forms.

Parameters

bool $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.

public FormConfigInterface getFormConfig()

Builds and returns the form configuration.

Return Value

FormConfigInterface

at line 32
public FormBuilderInterface add(string|int|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|int|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 bool has(string $name)

Returns whether a field with the given name exists.

Parameters

string $name

Return Value

bool

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