FormConfigInterface
in
The configuration of a {@link Form} object.
Tags
Table of Contents
- getAction() : string
- Returns the target URL of the form.
- getAttribute() : mixed
- Returns the value of the given attribute.
- getAttributes() : array<string|int, mixed>
- Returns additional attributes of the form.
- getAutoInitialize() : bool
- Returns whether the form should be initialized upon creation.
- getByReference() : bool
- Returns whether the form's data should be modified by reference.
- getCompound() : bool
- Returns whether the form is compound.
- getData() : mixed
- Returns the initial data of the form.
- getDataClass() : string|null
- Returns the class of the view data or null if the data is scalar or an array.
- getDataLocked() : bool
- Returns whether the form's data is locked.
- getDataMapper() : DataMapperInterface|null
- Returns the data mapper of the compound form or null for a simple form.
- getDisabled() : bool
- Returns whether the form is disabled.
- getEmptyData() : mixed
- Used when the view data is empty on submission.
- getErrorBubbling() : bool
- Returns whether errors attached to the form will bubble to its parent.
- getEventDispatcher() : EventDispatcherInterface
- Returns the event dispatcher used to dispatch form events.
- getFormFactory() : FormFactoryInterface
- Returns the form factory used for creating new forms.
- getInheritData() : bool
- Returns whether the form should read and write the data of its parent.
- getMapped() : bool
- Returns whether the form should be mapped to an element of its parent's data.
- getMethod() : string
- Returns the HTTP method used by the form.
- getModelTransformers() : array<string|int, DataTransformerInterface>
- Returns the model transformers of the form.
- getName() : string
- Returns the name of the form used as HTTP parameter.
- getOption() : mixed
- Returns the value of a specific option.
- getOptions() : array<string, mixed>
- Returns all options passed during the construction of the form.
- getPropertyPath() : PropertyPathInterface|null
- Returns the property path that the form should be mapped to.
- getRequestHandler() : RequestHandlerInterface
- Returns the request handler used by the form.
- getRequired() : bool
- Returns whether the form is required.
- getType() : ResolvedFormTypeInterface
- Returns the resolved form type used to construct the form.
- getViewTransformers() : array<string|int, DataTransformerInterface>
- Returns the view transformers of the form.
- hasAttribute() : bool
- Returns whether the attribute with the given name exists.
- hasOption() : bool
- Returns whether a specific option exists.
Methods
getAction()
Returns the target URL of the form.
public
getAction() : string
Return values
string —The target URL of the form
getAttribute()
Returns the value of the given attribute.
public
getAttribute(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
-
The attribute name
- $default : mixed = null
-
The value returned if the attribute does not exist
Return values
mixed —The attribute value
getAttributes()
Returns additional attributes of the form.
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of key-value combinations
getAutoInitialize()
Returns whether the form should be initialized upon creation.
public
getAutoInitialize() : bool
Return values
bool —returns true if the form should be initialized when created, false otherwise
getByReference()
Returns whether the form's data should be modified by reference.
public
getByReference() : bool
Return values
bool —Whether to modify the form's data by reference
getCompound()
Returns whether the form is compound.
public
getCompound() : bool
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. The contrary is not possible, a form which is not compound cannot have any children.
Return values
bool —Whether the form is compound
getData()
Returns the initial data of the form.
public
getData() : mixed
Return values
mixed —The initial form data
getDataClass()
Returns the class of the view data or null if the data is scalar or an array.
public
getDataClass() : string|null
Return values
string|null —The data class or null
getDataLocked()
Returns whether the form's data is locked.
public
getDataLocked() : bool
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 values
bool —Whether the data is locked
getDataMapper()
Returns the data mapper of the compound form or null for a simple form.
public
getDataMapper() : DataMapperInterface|null
Return values
DataMapperInterface|null —The data mapper
getDisabled()
Returns whether the form is disabled.
public
getDisabled() : bool
Return values
bool —Whether the form is disabled
getEmptyData()
Used when the view data is empty on submission.
public
getEmptyData() : mixed
When the form is compound it will also be used to map the children data.
The empty data must match the view format as it will passed to the first view transformer's "reverseTransform" method.
Return values
mixed —The data used when the submitted form is initially empty
getErrorBubbling()
Returns whether errors attached to the form will bubble to its parent.
public
getErrorBubbling() : bool
Return values
bool —Whether errors will bubble up
getEventDispatcher()
Returns the event dispatcher used to dispatch form events.
public
getEventDispatcher() : EventDispatcherInterface
Return values
EventDispatcherInterface —The dispatcher
getFormFactory()
Returns the form factory used for creating new forms.
public
getFormFactory() : FormFactoryInterface
Return values
FormFactoryInterface —The form factory
getInheritData()
Returns whether the form should read and write the data of its parent.
public
getInheritData() : bool
Return values
bool —Whether the form should inherit its parent's data
getMapped()
Returns whether the form should be mapped to an element of its parent's data.
public
getMapped() : bool
Return values
bool —Whether the form is mapped
getMethod()
Returns the HTTP method used by the form.
public
getMethod() : string
Return values
string —The HTTP method of the form
getModelTransformers()
Returns the model transformers of the form.
public
getModelTransformers() : array<string|int, DataTransformerInterface>
Return values
array<string|int, DataTransformerInterface> —getName()
Returns the name of the form used as HTTP parameter.
public
getName() : string
Return values
string —The form name
getOption()
Returns the value of a specific option.
public
getOption(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
-
The option name
- $default : mixed = null
-
The value returned if the option does not exist
Return values
mixed —The option value
getOptions()
Returns all options passed during the construction of the form.
public
getOptions() : array<string, mixed>
Return values
array<string, mixed> —The passed options
getPropertyPath()
Returns the property path that the form should be mapped to.
public
getPropertyPath() : PropertyPathInterface|null
Return values
PropertyPathInterface|null —The property path
getRequestHandler()
Returns the request handler used by the form.
public
getRequestHandler() : RequestHandlerInterface
Return values
RequestHandlerInterface —The request handler
getRequired()
Returns whether the form is required.
public
getRequired() : bool
Return values
bool —Whether the form is required
getType()
Returns the resolved form type used to construct the form.
public
getType() : ResolvedFormTypeInterface
Return values
ResolvedFormTypeInterface —The form's resolved type
getViewTransformers()
Returns the view transformers of the form.
public
getViewTransformers() : array<string|int, DataTransformerInterface>
Return values
array<string|int, DataTransformerInterface> —hasAttribute()
Returns whether the attribute with the given name exists.
public
hasAttribute(string $name) : bool
Parameters
- $name : string
-
The attribute name
Return values
bool —Whether the attribute exists
hasOption()
Returns whether a specific option exists.
public
hasOption(string $name) : bool
Parameters
- $name : string
-
The option name,
Return values
bool —Whether the option exists