package Default
inherited_from \Zend\Form\Element

 Methods

Make a deep clone of a fieldset

__clone() : void

__construct()

__construct(null|integer|string $name = null, array $options = array()
inherited_from \Zend\Form\Element::__construct()

Parameters

$name

nullintegerstring

Optional name for the element

$options

array

Optional options for the element

__construct()

__construct(null|integer|string $name = null, array $options = array()
Inherited

Parameters

$name

nullintegerstring

Optional name for the element

$options

array

Optional options for the element

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Add an element or fieldset

add(array|\Traversable|\Zend\Form\ElementInterface $elementOrFieldset, array $flags = array()) : \Zend\Form\Fieldset | \Zend\Form\FieldsetInterface

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

todo Should we detect if the element/fieldset name conflicts?
inherited_from \Zend\Form\FieldsetInterface::add()

Parameters

$elementOrFieldset

array\Traversable\Zend\Form\ElementInterface

$flags

array

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Fieldset\Zend\Form\FieldsetInterface

Checks if the object can be set in this fieldset

allowObjectBinding(object $object) : boolean
inherited_from \Zend\Form\FieldsetInterface::allowObjectBinding()

Parameters

$object

object

Returns

boolean

Checks if this fieldset can bind data

allowValueBinding() : boolean
inherited_from \Zend\Form\FieldsetInterface::allowValueBinding()

Returns

boolean

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

allowedObjectBindingClass() : string

Returns

string

Bind values to the bound object

bindValues(array $values = array()) : mixed | void
inherited_from \Zend\Form\FieldsetInterface::bindValues()

Parameters

$values

array

Returns

mixedvoid

Clear all attributes

clearAttributes() : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementAttributeRemovalInterface::clearAttributes()

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Clear all label options

clearLabelOptions() : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\LabelAwareInterface::clearLabelOptions()

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Countable: return count of attached elements/fieldsets

count() : integer

Returns

integer

Retrieve a named element or fieldset

get(string $elementOrFieldset) : \Zend\Form\ElementInterface
inherited_from \Zend\Form\FieldsetInterface::get()

Parameters

$elementOrFieldset

string

Returns

\Zend\Form\ElementInterface

Retrieve a single element attribute

getAttribute(string $key) : mixed | null
Inherited
inherited_from \Zend\Form\ElementInterface::getAttribute()

Parameters

$key

Returns

mixednull

Retrieve all attributes at once

getAttributes() : array | \Traversable
Inherited
inherited_from \Zend\Form\ElementInterface::getAttributes()

Returns

array\Traversable

Retrieve all attached elements

getElements() : array | \Traversable

Storage is an implementation detail of the concrete class.

inherited_from \Zend\Form\FieldsetInterface::getElements()

Returns

array\Traversable

Retrieve all attached fieldsets

getFieldsets() : array | \Traversable

Storage is an implementation detail of the concrete class.

inherited_from \Zend\Form\FieldsetInterface::getFieldsets()

Returns

array\Traversable

Retrieve composed form factory

getFormFactory() : \Zend\Form\Factory

Lazy-loads one if none present.

Returns

\Zend\Form\Factory

Get the hydrator used when binding an object to the fieldset

getHydrator() : \Zend\Stdlib\Hydrator\HydratorInterface

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.

inherited_from \Zend\Form\FieldsetInterface::getHydrator()

Returns

\Zend\Stdlib\Hydrator\HydratorInterface

IteratorAggregate: return internal iterator

getIterator() : \Zend\Stdlib\PriorityList

Returns

\Zend\Stdlib\PriorityList

Retrieve the label used for this element

getLabel() : null | string
Inherited
inherited_from \Zend\Form\ElementInterface::getLabel()

Returns

nullstring

Get the attributes to use with the label

getLabelAttributes() : array
Inherited
inherited_from \Zend\Form\LabelAwareInterface::getLabelAttributes()

Returns

array

Retrieve a single label option

getLabelOption($key) : mixed | null
Inherited
inherited_from \Zend\Form\LabelAwareInterface::getLabelOption()

Parameters

$key

Returns

mixednull

Get label specific options

getLabelOptions() : array
Inherited
inherited_from \Zend\Form\LabelAwareInterface::getLabelOptions()

Returns

array

Get validation error messages, if any

getMessages(null|string $elementName = null) : array | \Traversable

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

inherited_from \Zend\Form\Element::getMessages()

Parameters

$elementName

nullstring

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

array\Traversable

Get validation error messages, if any.

getMessages() : array | \Traversable
Inherited

Returns a list of validation failure messages, if any.

inherited_from \Zend\Form\ElementInterface::getMessages()

Returns

array\Traversable

Get value for name

getName() : string | integer
Inherited
inherited_from \Zend\Form\ElementInterface::getName()

Returns

stringinteger

Get the object used by the hydrator

getObject() : mixed
inherited_from \Zend\Form\FieldsetInterface::getObject()

Returns

mixed

Return the specified option

getOption(string $option) : NULL | mixed
Inherited
inherited_from \Zend\Form\ElementInterface::getOption()

Parameters

$option

string

Returns

NULLmixed

Get defined options

getOptions() : array
Inherited
inherited_from \Zend\Form\ElementInterface::getOptions()

Returns

array

Retrieve the element value

getValue() : mixed
Inherited
inherited_from \Zend\Form\ElementInterface::getValue()

Returns

mixed

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

has(string $elementOrFieldset) : boolean
inherited_from \Zend\Form\FieldsetInterface::has()

Parameters

$elementOrFieldset

string

Returns

boolean

Does the element has a specific attribute ?

hasAttribute(string $key) : boolean
Inherited
inherited_from \Zend\Form\ElementInterface::hasAttribute()

Parameters

$key

string

Returns

boolean

Does the element has a specific label option ?

hasLabelOption(string $key) : boolean
Inherited
inherited_from \Zend\Form\LabelAwareInterface::hasLabelOption()

Parameters

$key

string

Returns

boolean

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

init() : void
Inherited

..)

inherited_from \Zend\Stdlib\InitializableInterface::init()

Recursively populate values of attached elements and fieldsets

populateValues(array|\Traversable $data) : void
inherited_from \Zend\Form\FieldsetInterface::populateValues()

Parameters

$data

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

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

prepareElement(\Zend\Form\FormInterface $form) : mixed | void

Parameters

$form

\Zend\Form\FormInterface

Returns

mixedvoid

Remove a named element or fieldset

remove(string $elementOrFieldset) : \Zend\Form\FieldsetInterface
inherited_from \Zend\Form\FieldsetInterface::remove()

Parameters

$elementOrFieldset

string

Returns

\Zend\Form\FieldsetInterface

Remove a single attribute

removeAttribute(string $key) : \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementAttributeRemovalInterface::removeAttribute()

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

removeAttributes(array $keys) : \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementAttributeRemovalInterface::removeAttributes()

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

Remove a single label option

removeLabelOption(string $key) : \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\LabelAwareInterface::removeLabelOption()

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

removeLabelOptions(array $keys) : \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\LabelAwareInterface::removeLabelOptions()

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

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

setAllowedObjectBindingClass(string $allowObjectBindingClass) 

Parameters

$allowObjectBindingClass

string

Set a single element attribute

setAttribute(string $key, mixed $value) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementInterface::setAttribute()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set many attributes at once

setAttributes(array|\Traversable $arrayOrTraversable) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited

Implementation will decide if this will overwrite or merge.

inherited_from \Zend\Form\ElementInterface::setAttributes()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

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

setFormFactory(\Zend\Form\Factory $factory) : \Zend\Form\Form

Parameters

$factory

\Zend\Form\Factory

Returns

\Zend\Form\Form

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

setHydrator(\Zend\Stdlib\Hydrator\HydratorInterface $hydrator) : \Zend\Form\FieldsetInterface
inherited_from \Zend\Form\FieldsetInterface::setHydrator()

Parameters

$hydrator

\Zend\Stdlib\Hydrator\HydratorInterface

Returns

\Zend\Form\FieldsetInterface

Set the label used for this element

setLabel($label) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementInterface::setLabel()

Parameters

$label

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set the attributes to use with the label

setLabelAttributes(array $labelAttributes) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\LabelAwareInterface::setLabelAttributes()

Parameters

$labelAttributes

array

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set a single label optionn

setLabelOption(string $key, mixed $value) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\LabelAwareInterface::setLabelOption()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set many label options at once

setLabelOptions(array|\Traversable $arrayOrTraversable) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited

Implementation will decide if this will overwrite or merge.

inherited_from \Zend\Form\LabelAwareInterface::setLabelOptions()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

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

setMessages(array|\Traversable $messages) : \Zend\Form\Element | \Zend\Form\ElementInterface | \Zend\Form\FieldsetInterface
inherited_from \Zend\Form\Element::setMessages()

Parameters

$messages

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface\Zend\Form\FieldsetInterface

Set a list of messages to report when validation fails

setMessages(array|\Traversable $messages) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementInterface::setMessages()

Parameters

$messages

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set value for name

setName(string $name) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited

In most cases, this will proxy to the attributes for storage, but is present to indicate that elements are generally named.

inherited_from \Zend\Form\ElementInterface::setName()

Parameters

$name

string

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set the object used by the hydrator

setObject(object $object) : \Zend\Form\Fieldset | \Zend\Form\FieldsetInterface
inherited_from \Zend\Form\FieldsetInterface::setObject()

Parameters

$object

object

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Fieldset\Zend\Form\FieldsetInterface

Set a single option for an element

setOption(string $key, mixed $value) : \Zend\Form\Fieldset
Inherited
inherited_from \Zend\Form\ElementInterface::setOption()
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Fieldset

Set options for a fieldset. Accepted options are: - use_as_base_fieldset: is this fieldset use as the base fieldset?

setOptions(array|\Traversable $options) : \Zend\Form\Element | \Zend\Form\ElementInterface
inherited_from \Zend\Form\Element::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set options for an element. Accepted options are: - label: label to associate with the element - label_attributes: attributes to use when the label is rendered - label_options: label specific options

setOptions(array|\Traversable $options) : \Zend\Form\Element | \Zend\Form\ElementInterface
Inherited
inherited_from \Zend\Form\ElementInterface::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

\Zend\Form\Element\Zend\Form\ElementInterface

Set/change the priority of an element or fieldset

setPriority(string $elementOrFieldset, integer $priority) : \Zend\Form\FieldsetInterface
inherited_from \Zend\Form\FieldsetInterface::setPriority()

Parameters

$elementOrFieldset

string

$priority

integer

Returns

\Zend\Form\FieldsetInterface

Set if this fieldset is used as a base fieldset

setUseAsBaseFieldset(boolean $useAsBaseFieldset) : \Zend\Form\Fieldset

Parameters

$useAsBaseFieldset

boolean

Returns

\Zend\Form\Fieldset

Set the element value

setValue(mixed $value) : \Zend\Form\Element
Inherited
inherited_from \Zend\Form\ElementInterface::setValue()

Parameters

$value

mixed

Returns

\Zend\Form\Element

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

useAsBaseFieldset() : boolean

Returns

boolean

Extract values from the bound object

extract() : array

Returns

array

 Properties

 

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

$allowedObjectBindingClass : string

Default

 

$attributes

$attributes : array

Default

array()
 

$elements

$elements : array

Default

array()
 

$factory

$factory : \Zend\Form\Factory

Default

 

$fieldsets

$fieldsets : array

Default

array()
 

Hydrator to use with bound object

$hydrator : \Zend\Stdlib\Hydrator\HydratorInterface

Default

 

$iterator

$iterator : \Zend\Stdlib\PriorityList

Default

 

$label

$label : null | string

Default

 

$labelAttributes

$labelAttributes : array

Default

array()
 

Label specific options

$labelOptions : array

Default

array()
 

$messages

$messages : array

Default

array()
inherited_from \Zend\Form\Element::messages
 

Validation error messages

$messages : array

Default

array()
 

The object bound to this fieldset, if any

$object : null | object

Default

 

custom options

$options : array

Default

array()
 

Should this fieldset be used as a base fieldset in the parent form ?

$useAsBaseFieldset : boolean

Default

false
 

$value

$value : mixed

Default