1. class
  2. Symfony
  3. Component
  4. Form
  5. FormConfigBuilder

FormConfigBuilder

class FormConfigBuilder implements FormConfigBuilderInterface

A basic form configuration.

Methods

__construct(string|int $name, string $dataClass, EventDispatcherInterface $dispatcher, array $options = array())

Creates an empty form configuration.

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

Adds an event listener to an event on this form.

FormConfigBuilderInterface
addEventSubscriber(EventSubscriberInterface $subscriber)

Adds an event subscriber for events on this form.

FormConfigBuilderInterface
addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Appends / prepends a transformer to the view transformer chain.

FormConfigBuilderInterface
resetViewTransformers()

Clears the view transformers.

FormConfigBuilderInterface
addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Prepends / appends a transformer to the normalization transformer chain.

FormConfigBuilderInterface
resetModelTransformers()

Clears the normalization transformers.

EventDispatcherInterface
getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

string
getName()

Returns the name of the form used as HTTP parameter.

null|PropertyPathInterface
getPropertyPath()

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

bool
getMapped()

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

bool
getByReference()

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

bool
getInheritData()

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

bool
getCompound()

Returns whether the form is compound.

ResolvedFormTypeInterface
getType()

Returns the form types used to construct the form.

DataTransformerInterface[]
getViewTransformers()

Returns the view transformers of the form.

DataTransformerInterface[]
getModelTransformers()

Returns the model transformers of the form.

DataMapperInterface
getDataMapper()

Returns the data mapper of the form.

bool
getRequired()

Returns whether the form is required.

bool
getDisabled()

Returns whether the form is disabled.

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

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

bool
getDataLocked()

Returns whether the form's data is locked.

FormFactoryInterface
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.

RequestHandlerInterface
getRequestHandler()

Returns the request handler used by the form.

bool
getAutoInitialize()

Returns whether the form should be initialized upon creation.

array
getOptions()

Returns all options passed during the construction of the form.

bool
hasOption(string $name)

Returns whether a specific option exists.

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

Returns the value of a specific option.

FormConfigBuilderInterface
setAttribute(string $name, mixed $value)

Sets the value for an attribute.

FormConfigBuilderInterface
setAttributes(array $attributes)

Sets the attributes.

FormConfigBuilderInterface
setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

FormConfigBuilderInterface
setDisabled(bool $disabled)

Set whether the form is disabled.

FormConfigBuilderInterface
setEmptyData(mixed $emptyData)

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

FormConfigBuilderInterface
setErrorBubbling(bool $errorBubbling)

Sets whether errors bubble up to the parent.

FormConfigBuilderInterface
setRequired(bool $required)

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

FormConfigBuilderInterface
setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

FormConfigBuilderInterface
setMapped(bool $mapped)

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

FormConfigBuilderInterface
setByReference(bool $byReference)

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

FormConfigBuilderInterface
setInheritData(bool $inheritData)

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

FormConfigBuilderInterface
setCompound(bool $compound)

Sets whether the form should be compound.

FormConfigBuilderInterface
setType(ResolvedFormTypeInterface $type)

Set the types.

FormConfigBuilderInterface
setData(mixed $data)

Sets the initial data of the form.

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

FormConfigBuilderInterface
setAction(string $action)

Sets the target URL of the form.

FormConfigBuilderInterface
setMethod(string $method)

Sets the HTTP method used by the form.

FormConfigBuilderInterface
setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

FormConfigBuilderInterface
setAutoInitialize(bool $initialize)

Sets whether the form should be initialized automatically.

FormConfigInterface
getFormConfig()

Builds and returns the form configuration.

static 
validateName(string|int $name)

Validates whether the given variable is a valid form name.

static bool
isValidName(string $name)

Returns whether the given variable contains a valid form name.

Details

at line line 191
__construct(string|int $name, string $dataClass, EventDispatcherInterface $dispatcher, array $options = array())

Creates an empty form configuration.

Parameters

string|int $name The form name
string $dataClass The class of the form's data
EventDispatcherInterface $dispatcher The event dispatcher
array $options The form options

Exceptions

InvalidArgumentException If the data class is not a valid class or if the name contains invalid characters.

at line line 208
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.

at line line 222
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.

at line line 236
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.

at line line 254
FormConfigBuilderInterface resetViewTransformers()

Clears the view transformers.

Return Value

FormConfigBuilderInterface The configuration object.

at line line 268
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.

at line line 286
FormConfigBuilderInterface resetModelTransformers()

Clears the normalization transformers.

Return Value

FormConfigBuilderInterface The configuration object.

at line line 300
EventDispatcherInterface getEventDispatcher()

Returns the event dispatcher used to dispatch form events.

Return Value

EventDispatcherInterface The dispatcher.

at line line 312
string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name.

at line line 320
null|PropertyPathInterface getPropertyPath()

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

Return Value

null|PropertyPathInterface The property path.

at line line 328
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.

at line line 336
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.

at line line 344
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.

at line line 352
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.

at line line 360
ResolvedFormTypeInterface getType()

Returns the form types used to construct the form.

Return Value

ResolvedFormTypeInterface The form's type.

at line line 368
DataTransformerInterface[] getViewTransformers()

Returns the view transformers of the form.

Return Value

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

at line line 376
DataTransformerInterface[] getModelTransformers()

Returns the model transformers of the form.

Return Value

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

at line line 384
DataMapperInterface getDataMapper()

Returns the data mapper of the form.

Return Value

DataMapperInterface The data mapper.

at line line 392
bool getRequired()

Returns whether the form is required.

Return Value

bool Whether the form is required.

at line line 400
bool getDisabled()

Returns whether the form is disabled.

Return Value

bool Whether the form is disabled.

at line line 408
bool getErrorBubbling()

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

Return Value

bool Whether errors will bubble up.

at line line 416
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.

at line line 424
array getAttributes()

Returns additional attributes of the form.

Return Value

array An array of key-value combinations.

at line line 432
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.

at line line 440
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.

at line line 448
mixed getData()

Returns the initial data of the form.

Return Value

mixed The initial form data.

at line line 456
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.

at line line 464
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.

at line line 472
FormFactoryInterface getFormFactory()

Returns the form factory used for creating new forms.

Return Value

FormFactoryInterface The form factory.

at line line 480
string getAction()

Returns the target URL of the form.

Return Value

string The target URL of the form.

at line line 488
string getMethod()

Returns the HTTP method used by the form.

Return Value

string The HTTP method of the form.

at line line 496
RequestHandlerInterface getRequestHandler()

Returns the request handler used by the form.

Return Value

RequestHandlerInterface The request handler.

at line line 511
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.

at line line 519
array getOptions()

Returns all options passed during the construction of the form.

Return Value

array The passed options.

at line line 527
bool hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

bool Whether the option exists.

at line line 535
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.

at line line 543
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.

at line line 557
FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes.

Return Value

FormConfigBuilderInterface The configuration object.

at line line 571
FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Sets the data mapper used by the form.

Parameters

DataMapperInterface $dataMapper

Return Value

FormConfigBuilderInterface The configuration object.

at line line 585
FormConfigBuilderInterface setDisabled(bool $disabled)

Set whether the form is disabled.

Parameters

bool $disabled Whether the form is disabled

Return Value

FormConfigBuilderInterface The configuration object.

at line line 599
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.

at line line 613
FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

Sets whether errors bubble up to the parent.

Parameters

bool $errorBubbling

Return Value

FormConfigBuilderInterface The configuration object.

at line line 627
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.

at line line 641
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.

at line line 659
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.

at line line 673
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.

at line line 687
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.

at line line 701
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.

at line line 715
FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Set the types.

Parameters

ResolvedFormTypeInterface $type The type of the form.

Return Value

FormConfigBuilderInterface The configuration object.

at line line 729
FormConfigBuilderInterface setData(mixed $data)

Sets the initial data of the form.

Parameters

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

Return Value

FormConfigBuilderInterface The configuration object.

at line line 743
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.

at line line 757
setFormFactory(FormFactoryInterface $formFactory)

Sets the form factory used for creating new forms.

Parameters

FormFactoryInterface $formFactory The form factory.

at line line 771
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.

at line line 785
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.

at line line 809
FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Sets the request handler used by the form.

Parameters

RequestHandlerInterface $requestHandler

Return Value

FormConfigBuilderInterface The configuration object.

at line line 823
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.

at line line 837
FormConfigInterface getFormConfig()

Builds and returns the form configuration.

Return Value

FormConfigInterface

at line line 858
static validateName(string|int $name)

Validates whether the given variable is a valid form name.

Parameters

string|int $name The tested form name.

Exceptions

UnexpectedTypeException If the name is not a string or an integer.
InvalidArgumentException If the name contains invalid characters.

at line line 886
static bool isValidName(string $name)

Returns whether the given variable contains a valid form name.

A name is accepted if it

  • is empty
  • starts with a letter, digit or underscore
  • contains only letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":")

Parameters

string $name The tested form name.

Return Value

bool Whether the name is valid.