Zend\Form\FormInterface
Synopsis
interface FormInterface
extends FieldsetInterface
{
- // constants
- const BIND_ON_VALIDATE = 0x00;
- const BIND_MANUAL = 0x01;
- const VALIDATE_ALL = 0x10;
- const VALUES_NORMALIZED = 0x11;
- const VALUES_RAW = 0x12;
- const VALUES_AS_ARRAY = 0x13;
- // methods
- public FormInterface setData()
- public mixed bind()
- public void setBindOnValidate()
- public FormInterface setInputFilter()
- public InputFilterInterface getInputFilter()
- public bool isValid()
- public array|object getData()
- public FormInterface setValidationGroup()
- // Inherited methods from FieldsetInterface
- public FieldsetInterface add()
- public bool has()
- public ElementInterface get()
- public FieldsetInterface remove()
- public FieldsetInterface setPriority()
- public Traversable getElements()
- public Traversable getFieldsets()
- public void populateValues()
- public FieldsetInterface setObject()
- public mixed getObject()
- public bool allowObjectBinding()
- public FieldsetInterface setHydrator()
- public null|HydratorInterface getHydrator()
- public mixed bindValues()
- public bool allowValueBinding()
- // Inherited methods from Countable
- public int count()
- // Inherited methods from IteratorAggregate
- public Traversable getIterator()
- // Inherited methods from ElementInterface
- public ElementInterface setName()
- public string getName()
- public ElementInterface setOptions()
- public self setOption()
- public array getOptions()
- public null|mixed getOption()
- public ElementInterface setAttribute()
- public mixed getAttribute()
- public bool hasAttribute()
- public ElementInterface setAttributes()
- public Traversable getAttributes()
- public ElementInterface setValue()
- public mixed getValue()
- public ElementInterface setLabel()
- public string getLabel()
- public ElementInterface setMessages()
- public Traversable getMessages()
- // Inherited methods from ElementPrepareAwareInterface
- public mixed prepareElement()
- // Inherited methods from FormFactoryAwareInterface
- public void setFormFactory()
Hierarchy
Constants
Name | Value |
---|---|
BIND_ON_VALIDATE | 0x00 |
BIND_MANUAL | 0x01 |
VALIDATE_ALL | 0x10 |
VALUES_NORMALIZED | 0x11 |
VALUES_RAW | 0x12 |
VALUES_AS_ARRAY | 0x13 |
Methods
public
- bind() — Bind an object to the element
- getData() — Retrieve the validated data
- getInputFilter() — Retrieve input filter
- isValid() — Validate the form
- setBindOnValidate() — Whether or not to bind values to the bound object when validation succeeds
- setData() — Set data to validate and/or populate elements
- setInputFilter() — Set input filter
- setValidationGroup() — Set the validation group (set of values to validate)
Inherited from Zend\Form\FieldsetInterface
public
- add() — Add an element or fieldset
- allowObjectBinding() — Checks if the object can be set in this fieldset
- allowValueBinding() — Checks if this fieldset can bind data
- bindValues() — Bind values to the bound object
- get() — Retrieve a named element or fieldset
- getElements() — Retrieve all attached elements
- getFieldsets() — Retrieve all attached fieldsets
- getHydrator() — Get the hydrator used when binding an object to the element
- getObject() — Get the object used by the hydrator
- has() — Does the fieldset have an element/fieldset by the given name?
- populateValues() — Recursively populate value attributes of elements
- remove() — Remove a named element or fieldset
- setHydrator() — Set the hydrator to use when binding an object to the element
- setObject() — Set the object used by the hydrator
- setPriority() — Set/change the priority of an element or fieldset
Inherited from Countable
public
- count() — Count elements of an object
Inherited from IteratorAggregate
public
- getIterator() — Retrieve an external iterator
Inherited from Zend\Form\ElementInterface
public
- getAttribute() — Retrieve a single element attribute
- getAttributes() — Retrieve all attributes at once
- getLabel() — Retrieve the label (if any) used for this element
- getMessages() — Get validation error messages, if any
- getName() — Retrieve the element name
- getOption() — return the specified option
- getOptions() — get the defined options
- getValue() — Retrieve the element value
- hasAttribute() — Return true if a specific attribute is set
- setAttribute() — Set a single element attribute
- setAttributes() — Set many attributes at once
- setLabel() — Set the label (if any) used for this element
- setMessages() — Set a list of messages to report when validation fails
- setName() — Set the name of this element
- setOption() — Set a single option for an element
- setOptions() — Set options for an element
- setValue() — Set the value of the element
Inherited from Zend\Form\ElementPrepareAwareInterface
public
- prepareElement() — Prepare the form element (mostly used for rendering purposes)
Inherited from Zend\Form\FormFactoryAwareInterface
public
- setFormFactory() — Compose a form factory into the object