Summary

Fully Qualified Name:	Laminas\Form\Form
Extends:	Fieldset
Implements:	FormInterface

Description

Methods

Name	Description	Defined By
__clone()	Make a deep clone of a fieldset	Fieldset
__construct()		Fieldset
add()	Add an element or fieldset	Form
allowObjectBinding()	Checks if the object can be set in this fieldset	Fieldset
allowValueBinding()	Checks if this fieldset can bind data	Fieldset
allowedObjectBindingClass()	Get The class or interface of objects that can be bound to this fieldset.	Fieldset
attachInputFilterDefaults()	Attach defaults provided by the elements to the input filter	Form
bind()	Bind an object to the form	Form
bindOnValidate()	Will we bind values to the bound object on successful validation?	Form
bindValues()	Bind values to the bound object	Form
clearAttributes()	Clear all attributes	Element
clearLabelOptions()	Clear all label options	Element
count()	Countable: return count of attached elements/fieldsets	Fieldset
get()	Retrieve a named element or fieldset	Fieldset
getAttribute()	Retrieve a single element attribute	Element
getAttributes()	Retrieve all attributes at once	Element
getBaseFieldset()	Get the base fieldset to use when hydrating	Form
getData()	Retrieve the validated data	Form
getElements()	Retrieve all attached elements	Fieldset
getFieldsets()	Retrieve all attached fieldsets	Fieldset
getFormFactory()	Retrieve composed form factory	Fieldset
getHydrator()	Get the hydrator used when binding an object to the fieldset	Fieldset
getInputFilter()	Retrieve input filter used by this form	Form
getIterator()	IteratorAggregate: return internal iterator	Fieldset
getLabel()	Retrieve the label used for this element	Element
getLabelAttributes()	Get the attributes to use with the label	Element
getLabelOption()	Retrieve a single label option	Element
getLabelOptions()	Get label specific options	Element
getMessages()	Get validation error messages, if any	Fieldset
getName()	Get value for name	Element
getObject()	Get the object used by the hydrator	Fieldset
getOption()	Return the specified option	Element
getOptions()	Get defined options	Element
getPreferFormInputFilter()	Should we use form input filter over element input filter defaults from elements and fieldsets?	Form
getValidationGroup()	Retrieve the current validation group, if any	Form
getValue()	Retrieve the element value	Element
has()	Does the fieldset have an element/fieldset by the given name?	Fieldset
hasAttribute()	Does the element has a specific attribute ?	Element
hasLabelOption()	Does the element has a specific label option ?	Element
hasValidated()	Check if the form has been validated	Form
init()	This function is automatically called when creating element with factory. It allows to perform various operations (add elements.	Element
isValid()	Validate the form	Form
populateValues()	{@inheritDoc}	Form
prepare()	Ensures state is ready for use	Form
prepareElement()	Ensures state is ready for use. Here, we append the name of the fieldsets to every elements in order to avoid name clashes if the same fieldset is used multiple times	Form
remove()	Remove a named element or fieldset	Fieldset
removeAttribute()	Remove a single attribute	Element
removeAttributes()	Remove many attributes at once	Element
removeLabelOption()	Remove a single label option	Element
removeLabelOptions()	Remove many attributes at once	Element
setAllowedObjectBindingClass()	Set the class or interface of objects that can be bound to this fieldset.	Fieldset
setAttribute()	Set a single element attribute	Element
setAttributes()	Set many attributes at once	Element
setBaseFieldset()	Set the base fieldset to use when hydrating	Form
setBindOnValidate()	Set flag indicating whether or not to bind values on successful validation	Form
setData()	Set data to validate and/or populate elements	Form
setFormFactory()	Compose a form factory to use when calling add() with a non-element/fieldset	Fieldset
setHydrator()	Set the hydrator to use when binding an object to the element	Form
setInputFilter()	Set the input filter used by this form	Form
setLabel()	Set the label used for this element	Element
setLabelAttributes()	Set the attributes to use with the label	Element
setLabelOption()	Set a single label optionn	Element
setLabelOptions()	Set many label options at once	Element
setMessages()	Set a hash of element names/messages to use when validation fails	Fieldset
setName()	Set value for name	Element
setObject()	Set the object used by the hydrator	Fieldset
setOption()	Set a single option for an element	Element
setOptions()	Set options for a form. Accepted options are: - prefer_form_input_filter: is form input filter is preferred?	Form
setPreferFormInputFilter()	Set flag indicating whether or not to prefer the form input filter over element and fieldset defaults	Form
setPriority()	Set/change the priority of an element or fieldset	Fieldset
setUseAsBaseFieldset()	Set if this fieldset is used as a base fieldset	Fieldset
setUseInputFilterDefaults()	Set flag indicating whether or not to scan elements and fieldsets for defaults	Form
setValidationGroup()	Set the validation group (set of values to validate)	Form
setValue()	Set the element value	Element
setWrapElements()	Are the form elements/fieldsets names wrapped by the form name ?	Form
useAsBaseFieldset()	Is this fieldset use as a base fieldset for a form ?	Fieldset
useInputFilterDefaults()	Should we use input filter defaults from elements and fieldsets?	Form
wrapElements()	If true, form elements/fieldsets name's are wrapped around the form name itself	Form

Method Details

__clone()

Make a deep clone of a fieldset

Returns: void

__construct()

Parameter Name	Type	Description
$name	null|int|string	Optional
$options	array	Optional

Returns:

add()

Add an element or fieldset

If $elementOrFieldset is an array or Traversable, passes the argument on to the composed factory to create the object before attaching it.

$flags could contain metadata such as the alias under which to register the element or fieldset, order in which to prioritize it, etc.

Parameter Name	Type	Description
$elementOrFieldset	array|\Traversable|\ElementInterface
$flags	array

Returns: $this

allowObjectBinding()

Checks if the object can be set in this fieldset

Parameter Name	Type	Description
$object	object

Returns: bool

allowValueBinding()

Checks if this fieldset can bind data

Returns: bool

allowedObjectBindingClass()

Get The class or interface of objects that can be bound to this fieldset.

Returns: string

attachInputFilterDefaults()

Attach defaults provided by the elements to the input filter

Parameter Name	Type	Description
$inputFilter	\InputFilterInterface
$fieldset	\FieldsetInterface	Fieldset

Returns: void

bind()

Bind an object to the form

Ensures the object is populated with validated values.

Parameter Name	Type	Description
$object	object
$flags	int

Returns: $this

bindOnValidate()

Will we bind values to the bound object on successful validation?

Returns: bool

bindValues()

Bind values to the bound object

Parameter Name	Type	Description
$values	array
$validationGroup

Returns: void

clearAttributes()

Clear all attributes

Returns: $this

clearLabelOptions()

Clear all label options

Returns: $this

count()

Countable: return count of attached elements/fieldsets

Returns: int

get()

Retrieve a named element or fieldset

Parameter Name	Type	Description
$elementOrFieldset	string

Returns: \ElementInterface|\FieldsetInterface

getAttribute()

Retrieve a single element attribute

Parameter Name	Type	Description
	$key
$key

Returns: mixed|null

getAttributes()

Retrieve all attributes at once

Returns: array|\Traversable

getBaseFieldset()

Get the base fieldset to use when hydrating

Returns: \FieldsetInterface

getData()

Retrieve the validated data

By default, retrieves normalized values; pass one of the FormInterface::VALUES_* constants to shape the behavior.

Parameter Name	Type	Description
$flag	int

Returns: array|object

getElements()

Retrieve all attached elements

Storage is an implementation detail of the concrete class.

Returns: array|\Traversable

getFieldsets()

Retrieve all attached fieldsets

Storage is an implementation detail of the concrete class.

Returns: array|\Traversable

getFormFactory()

Retrieve composed form factory

Lazy-loads one if none present.

Returns: \Factory

getHydrator()

Get the hydrator used when binding an object to the fieldset

If no hydrator is present and object implements HydratorAwareInterface, hydrator will be retrieved from the object.

Will lazy-load Hydrator\ArraySerializable if none is present.

Returns: \HydratorInterface

getInputFilter()

Retrieve input filter used by this form

Returns: null|\InputFilterInterface

getIterator()

IteratorAggregate: return internal iterator

Returns: \PriorityList

getLabel()

Retrieve the label used for this element

Returns: null|string

getLabelAttributes()

Get the attributes to use with the label

Returns: array

getLabelOption()

Retrieve a single label option

Parameter Name	Type	Description
	$key
$key

Returns: mixed|null

getLabelOptions()

Get label specific options

Returns: array

getMessages()

Get validation error messages, if any

Returns a hash of element names/messages for all elements failing validation, or, if $elementName is provided, messages for that element only.

Parameter Name	Type	Description
$elementName	null|string

Returns: array|\Traversable

getName()

Get value for name

Returns: string|int

getObject()

Get the object used by the hydrator

Returns: mixed

getOption()

Return the specified option

Parameter Name	Type	Description
$option	string

Returns: null|mixed

getOptions()

Get defined options

Returns: array

getPreferFormInputFilter()

Should we use form input filter over element input filter defaults from elements and fieldsets?

Returns: bool

getValidationGroup()

Retrieve the current validation group, if any

Returns: null|array

getValue()

Retrieve the element value

Returns: mixed

has()

Does the fieldset have an element/fieldset by the given name?

Parameter Name	Type	Description
$elementOrFieldset	string

Returns: bool

hasAttribute()

Does the element has a specific attribute ?

Parameter Name	Type	Description
$key	string

Returns: bool

hasLabelOption()

Does the element has a specific label option ?

Parameter Name	Type	Description
$key	string

Returns: bool

hasValidated()

Check if the form has been validated

Returns: bool

init()

This function is automatically called when creating element with factory. It allows to perform various operations (add elements.

..)

Returns: void

isValid()

Validate the form

Typically, will proxy to the composed input filter.

Returns: bool

populateValues()

{@inheritDoc}

Parameter Name	Type	Description
$onlyBase	bool
$data

Returns:

prepare()

Ensures state is ready for use

Marshalls the input filter, to ensure validation error messages are available, and prepares any elements and/or fieldsets that require preparation.

Returns: $this

prepareElement()

Ensures state is ready for use. Here, we append the name of the fieldsets to every elements in order to avoid name clashes if the same fieldset is used multiple times

Parameter Name	Type	Description
$form	\FormInterface

Returns: void

remove()

Remove a named element or fieldset

Parameter Name	Type	Description
$elementOrFieldset	string

Returns: $this

removeAttribute()

Remove a single attribute

Parameter Name	Type	Description
$key	string

Returns: $this

removeAttributes()

Remove many attributes at once

Parameter Name	Type	Description
$keys	array

Returns: $this

removeLabelOption()

Remove a single label option

Parameter Name	Type	Description
$key	string

Returns: $this

removeLabelOptions()

Remove many attributes at once

Parameter Name	Type	Description
$keys	array

Returns: $this

setAllowedObjectBindingClass()

Set the class or interface of objects that can be bound to this fieldset.

Parameter Name	Type	Description
$allowObjectBindingClass	string

Returns:

setAttribute()

Set a single element attribute

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: $this

setAttributes()

Set many attributes at once

Implementation will decide if this will overwrite or merge.

Parameter Name	Type	Description
$arrayOrTraversable	array|\Traversable

Returns: $this

setBaseFieldset()

Set the base fieldset to use when hydrating

Parameter Name	Type	Description
$baseFieldset	\FieldsetInterface

Returns: $this

setBindOnValidate()

Set flag indicating whether or not to bind values on successful validation

Parameter Name	Type	Description
$bindOnValidateFlag	int

Returns: $this

setData()

Set data to validate and/or populate elements

Typically, also passes data on to the composed input filter.

Parameter Name	Type	Description
$data	array|\ArrayAccess|\Traversable

Returns: $this

setFormFactory()

Compose a form factory to use when calling add() with a non-element/fieldset

Parameter Name	Type	Description
$factory	\Factory

Returns: $this

setHydrator()

Set the hydrator to use when binding an object to the element

Parameter Name	Type	Description
$hydrator	\HydratorInterface

Returns: $this

setInputFilter()

Set the input filter used by this form

Parameter Name	Type	Description
$inputFilter	\InputFilterInterface

Returns: $this

setLabel()

Set the label used for this element

Parameter Name	Type	Description
	$label
$label

Returns: $this

setLabelAttributes()

Set the attributes to use with the label

Parameter Name	Type	Description
$labelAttributes	array

Returns: $this

setLabelOption()

Set a single label optionn

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: $this

setLabelOptions()

Set many label options at once

Implementation will decide if this will overwrite or merge.

Parameter Name	Type	Description
$arrayOrTraversable	array|\Traversable

Returns: $this

setMessages()

Set a hash of element names/messages to use when validation fails

Parameter Name	Type	Description
$messages	array|\Traversable

Returns: $this

setName()

Set value for name

Parameter Name	Type	Description
$name	string

Returns: $this

setObject()

Set the object used by the hydrator

Parameter Name	Type	Description
$object	object

Returns: $this

setOption()

Set a single option for an element

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: $this

setOptions()

Set options for a form. Accepted options are: - prefer_form_input_filter: is form input filter is preferred?

Parameter Name	Type	Description
$options	array|\Traversable

Returns: $this

setPreferFormInputFilter()

Set flag indicating whether or not to prefer the form input filter over element and fieldset defaults

Parameter Name	Type	Description
$preferFormInputFilter	bool

Returns: $this

setPriority()

Set/change the priority of an element or fieldset

Parameter Name	Type	Description
$elementOrFieldset	string
$priority	int

Returns: $this

setUseAsBaseFieldset()

Set if this fieldset is used as a base fieldset

Parameter Name	Type	Description
$useAsBaseFieldset	bool

Returns: $this

setUseInputFilterDefaults()

Set flag indicating whether or not to scan elements and fieldsets for defaults

Parameter Name	Type	Description
$useInputFilterDefaults	bool

Returns: $this

setValidationGroup()

Set the validation group (set of values to validate)

Typically, proxies to the composed input filter

Returns: $this

setValue()

Set the element value

Parameter Name	Type	Description
$value	mixed

Returns: $this

setWrapElements()

Are the form elements/fieldsets names wrapped by the form name ?

Parameter Name	Type	Description
$wrapElements	bool

Returns: $this

useAsBaseFieldset()

Is this fieldset use as a base fieldset for a form ?

Returns: bool

useInputFilterDefaults()

Should we use input filter defaults from elements and fieldsets?

Returns: bool

wrapElements()

If true, form elements/fieldsets name's are wrapped around the form name itself

Returns: bool