copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

__construct()

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

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

Parameters

$name

nullintstring

Optional name for the element

$options

array

Optional options for the element

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Clear all attributes

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

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

Returns

Retrieve a single element attribute

getAttribute($key) : mixed | null
Inherited

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

Parameters

$key

Returns

mixednull

Retrieve all attributes at once

getAttributes() : array | \Traversable
Inherited

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

Returns

array\Traversable

Get the value to use when checkbox is checked

getCheckedValue() : string

Returns

string

Provide default input rules for this element

getInputSpecification() : array

Attaches the captcha as a validator.

Returns

array

Retrieve the label used for this element

getLabel() : string
Inherited

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

Returns

string

Get the attributes to use with the label

getLabelAttributes() : array
Inherited

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

Returns

array

Get validation error messages, if any.

getMessages() : array | \Traversable
Inherited

Returns a list of validation failure messages, if any.

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

Returns

array\Traversable

Get value for name

getName() : string | int
Inherited

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

Returns

stringint

Return the specified option

getOption(string $option) : NULL | mixed
Inherited

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

Parameters

$option

string

Returns

NULLmixed

Get defined options

getOptions() : array
Inherited

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

Returns

array

Get the value to use when checkbox is unchecked

getUncheckedValue() : string

Returns

string

Retrieve the element value

getValue() : mixed
Inherited

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

Returns

mixed

Does the element has a specific attribute ?

hasAttribute(string $key) : bool
Inherited

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

Parameters

$key

string

Returns

bool

This function is automatically called when creating element with factory.

init() : void
Inherited

It allows to perform various operations (add elements...)

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

Checks if this checkbox is checked.

isChecked() : bool

Returns

bool

Remove a single attribute

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

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

Parameters

$key

string

Returns

Remove many attributes at once

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

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

Parameters

$keys

array

Returns

Set a single element attribute

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

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

Parameters

$key

string

$value

mixed

Returns

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\Element::setAttributes()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

Checks or unchecks the checkbox.

setChecked(bool $value) : \Zend\Form\Element\Checkbox

Parameters

$value

bool

The flag to set.

Returns

Set the value to use when checkbox is checked

setCheckedValue($checkedValue) : \Zend\Form\Element\Checkbox

Parameters

$checkedValue

Returns

Set the label used for this element

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

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

Parameters

$label

Returns

Set the attributes to use with the label

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

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

Parameters

$labelAttributes

array

Returns

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\Element::setMessages()

Parameters

$messages

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

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\Element::setName()

Parameters

$name

string

Returns

Accepted options for MultiCheckbox: - use_hidden_element: do we render hidden element? - unchecked_value: value for checkbox when unchecked - checked_value: value for checkbox when checked

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

Accepted options are: - label: label to associate with the element - label_attributes: attributes to use when the label is rendered

Parameters

$options

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

Set the value to use when checkbox is unchecked

setUncheckedValue($uncheckedValue) : \Zend\Form\Element\Checkbox

Parameters

$uncheckedValue

Returns

Do we render hidden element?

setUseHiddenElement(bool $useHiddenElement) : \Zend\Form\Element\Checkbox

Parameters

$useHiddenElement

bool

Returns

Checks or unchecks the checkbox.

setValue(mixed $value) : \Zend\Form\Element

Parameters

$value

mixed

A boolean flag or string that is checked against the "checked value".

Returns

Do we render hidden element?

useHiddenElement() : bool

Returns

bool

 Properties

 

Seed attributes

$attributes : array

 

$checkedValue

$checkedValue : string

 

$label

$label : string
Inherited

inherited_from \Zend\Form\Element::$$label
 

$labelAttributes

$labelAttributes : array
Inherited

inherited_from \Zend\Form\Element::$$labelAttributes
 

<p>Validation error messages</p>

$messages : array
Inherited

inherited_from \Zend\Form\Element::$$messages
 

<p>custom options</p>

$options : array
Inherited

inherited_from \Zend\Form\Element::$$options
 

$uncheckedValue

$uncheckedValue : string

 

$useHiddenElement

$useHiddenElement : bool

 

$validator

$validator : \Zend\Validator\ValidatorInterface

 

$value

$value : mixed
Inherited

inherited_from \Zend\Form\Element::$$value