FormConfigInterface (Component\Form)
Symfony\Component\Form\FormConfigInterface
interface FormConfigInterface
The configuration of a {@link Form} object.
Methods
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. |
Details
public EventDispatcherInterface getEventDispatcher()
Returns the event dispatcher used to dispatch form events.
public string getName()
Returns the name of the form used as HTTP parameter.
public null|PropertyPathInterface getPropertyPath()
Returns the property path that the form should be mapped to.
public bool getMapped()
Returns whether the form should be mapped to an element of its parent's data.
public bool getByReference()
Returns whether the form's data should be modified by reference.
public bool getInheritData()
Returns whether the form should read and write the data of its parent.
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.
public ResolvedFormTypeInterface getType()
Returns the form types used to construct the form.
public DataTransformerInterface[] getViewTransformers()
Returns the view transformers of the form.
public DataTransformerInterface[] getModelTransformers()
Returns the model transformers of the form.
public DataMapperInterface getDataMapper()
Returns the data mapper of the form.
public bool getRequired()
Returns whether the form is required.
public bool getDisabled()
Returns whether the form is disabled.
public bool getErrorBubbling()
Returns whether errors attached to the form will bubble to its parent.
public mixed getEmptyData()
Returns the data that should be returned when the form is empty.
public array getAttributes()
Returns additional attributes of the form.
public bool hasAttribute(string $name)
Returns whether the attribute with the given name exists.
public mixed getAttribute(string $name, mixed $default = null)
Returns the value of the given attribute.
public mixed getData()
Returns the initial data of the form.
public string getDataClass()
Returns the class of the form data or null if the data is scalar or an array.
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.
public FormFactoryInterface getFormFactory()
Returns the form factory used for creating new forms.
public string getAction()
Returns the target URL of the form.
public string getMethod()
Returns the HTTP method used by the form.
public RequestHandlerInterface getRequestHandler()
Returns the request handler used by the form.
public bool getAutoInitialize()
Returns whether the form should be initialized upon creation.
public array getOptions()
Returns all options passed during the construction of the form.
public bool hasOption(string $name)
Returns whether a specific option exists.
public mixed getOption(string $name, mixed $default = null)
Returns the value of a specific option.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/FormConfigInterface.html