package Default
inherited_from \Zend\Form\Element\MultiCheckbox

 Methods

__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

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

Get the disable in array validator flag.

disableInArrayValidator() : boolean
Inherited

Returns

boolean

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

Get the value to use when checkbox is checked

getCheckedValue() : string
Inherited

Returns

string

Provide default input rules for this element

getInputSpecification() : array
Inherited

Attaches the captcha as a validator.

inherited_from \Zend\InputFilter\InputProviderInterface::getInputSpecification()

Returns

array

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() : 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

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

Get the value to use when checkbox is unchecked

getUncheckedValue() : string
Inherited

Returns

string

Retrieve the element value

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

Returns

mixed

getValueOptions()

getValueOptions() : array
Inherited

Returns

array

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()

Checks if this checkbox is checked.

isChecked() : boolean
Inherited

Returns

boolean

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 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

Checks or unchecks the checkbox.

setChecked(boolean $value) : \Zend\Form\Element\Checkbox
Inherited

Parameters

$value

boolean

The flag to set.

Returns

\Zend\Form\Element\Checkbox

Set the value to use when checkbox is checked

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

Parameters

$checkedValue

Returns

\Zend\Form\Element\Checkbox

Set the flag to allow for disabling the automatic addition of an InArray validator.

setDisableInArrayValidator(boolean $disableOption) : \Zend\Form\Element\Select
Inherited

Parameters

$disableOption

boolean

Returns

\Zend\Form\Element\Select

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 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 a single option for an element

setOption(string $key, mixed $value) : \Zend\Form\Element\Radio
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\Element\Radio

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 the value to use when checkbox is unchecked

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

Parameters

$uncheckedValue

Returns

\Zend\Form\Element\Checkbox

Do we render hidden element?

setUseHiddenElement(boolean $useHiddenElement) : \Zend\Form\Element\Checkbox
Inherited

Parameters

$useHiddenElement

boolean

Returns

\Zend\Form\Element\Checkbox

Set the element value

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

Parameters

$value

mixed

Returns

\Zend\Form\Element

setValueOptions()

setValueOptions(array $options) : \Zend\Form\Element\MultiCheckbox
Inherited

Parameters

$options

array

Returns

\Zend\Form\Element\MultiCheckbox

unsetValueOption()

unsetValueOption(string $key) : \Zend\Form\Element\Radio
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

string

Returns

\Zend\Form\Element\Radio

Do we render hidden element?

useHiddenElement() : boolean
Inherited

Returns

boolean

Get validator

getValidator() : \Zend\Validator\ValidatorInterface
inherited_from \Zend\Form\Element\MultiCheckbox::getValidator()

Returns

\Zend\Validator\ValidatorInterface

Get validator

getValidator() : \Zend\Validator\ValidatorInterface
Inherited

Returns

\Zend\Validator\ValidatorInterface

Get only the values from the options attribute

getValueOptionsValues() : array
Inherited

Returns

array

 Properties

 

Seed attributes

$attributes : array

Default

array('type' => 'radio')
inherited_from \Zend\Form\Element\MultiCheckbox::attributes
 

$attributes

$attributes : array

Default

array()
 

$checkedValue

$checkedValue : string

Default

'1'
 

$disableInArrayValidator

$disableInArrayValidator : boolean

Default

false
 

$label

$label : null | string

Default

 

$labelAttributes

$labelAttributes : array

Default

array()
 

Label specific options

$labelOptions : array

Default

array()
 

Validation error messages

$messages : array

Default

array()
 

custom options

$options : array

Default

array()
 

$uncheckedValue

$uncheckedValue : string

Default

'0'
 

$useHiddenElement

$useHiddenElement : boolean

Default

true
 

$validator

$validator : \Zend\Validator\ValidatorInterface

Default

 

$value

$value : mixed

Default

 

$valueOptions

$valueOptions : array

Default

array()