Summary

Fully Qualified Name:	Zend\Form\Element\Checkbox
Extends:	Element
Implements:	InputProviderInterface

Description

Methods

Name	Description	Defined By
__construct()		Element
clearAttributes()	Clear all attributes	Element
clearLabelOptions()	Clear all label options	Element
getAttribute()	Retrieve a single element attribute	Element
getAttributes()	Retrieve all attributes at once	Element
getCheckedValue()	Get the value to use when checkbox is checked	Checkbox
getInputSpecification()	Provide default input rules for this element	Checkbox
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.	Element
getName()	Get value for name	Element
getOption()	Return the specified option	Element
getOptions()	Get defined options	Element
getUncheckedValue()	Get the value to use when checkbox is unchecked	Checkbox
getValue()	Retrieve the element value	Element
hasAttribute()	Does the element has a specific attribute ?	Element
hasLabelOption()	Does the element has a specific label option ?	Element
init()	This function is automatically called when creating element with factory. It allows to perform various operations (add elements.	Element
isChecked()	Checks if this checkbox is checked.	Checkbox
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
setAttribute()	Set a single element attribute	Element
setAttributes()	Set many attributes at once	Element
setChecked()	Checks or unchecks the checkbox.	Checkbox
setCheckedValue()	Set the value to use when checkbox is checked	Checkbox
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 list of messages to report when validation fails	Element
setName()	Set value for name	Element
setOption()	Set a single option for an element	Element
setOptions()	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	Checkbox
setUncheckedValue()	Set the value to use when checkbox is unchecked	Checkbox
setUseHiddenElement()	Do we render hidden element?	Checkbox
setValue()	Checks or unchecks the checkbox.	Checkbox
useHiddenElement()	Do we render hidden element?	Checkbox

Method Details

__construct()

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

Returns:

clearAttributes()

Clear all attributes

Returns: \Element|\ElementInterface

clearLabelOptions()

Clear all label options

Returns: \Element|\ElementInterface

getAttribute()

Retrieve a single element attribute

Parameter Name	Type	Description
	$key
$key

Returns: mixed|null

getAttributes()

Retrieve all attributes at once

Returns: array|\Traversable

getCheckedValue()

Get the value to use when checkbox is checked

Returns: string

getInputSpecification()

Provide default input rules for this element

Attaches the captcha as a validator.

Returns: array

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 list of validation failure messages, if any.

Returns: array|\Traversable

getName()

Get value for name

Returns: string|int

getOption()

Return the specified option

Parameter Name	Type	Description
$option	string

Returns: null|mixed

getOptions()

Get defined options

Returns: array

getUncheckedValue()

Get the value to use when checkbox is unchecked

Returns: string

getValue()

Retrieve the element value

Returns: mixed

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

init()

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

..)

Returns: void

isChecked()

Checks if this checkbox is checked.

Returns: bool

removeAttribute()

Remove a single attribute

Parameter Name	Type	Description
$key	string

Returns: \ElementInterface

removeAttributes()

Remove many attributes at once

Parameter Name	Type	Description
$keys	array

Returns: \ElementInterface

removeLabelOption()

Remove a single label option

Parameter Name	Type	Description
$key	string

Returns: \ElementInterface

removeLabelOptions()

Remove many attributes at once

Parameter Name	Type	Description
$keys	array

Returns: \ElementInterface

setAttribute()

Set a single element attribute

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: \Element|\ElementInterface

setAttributes()

Set many attributes at once

Implementation will decide if this will overwrite or merge.

Parameter Name	Type	Description
$arrayOrTraversable	array|\Traversable

Returns: \Element|\ElementInterface

setChecked()

Checks or unchecks the checkbox.

Parameter Name	Type	Description
$value	bool	The

Returns: \Checkbox

setCheckedValue()

Set the value to use when checkbox is checked

Parameter Name	Type	Description
	$checkedValue
$checkedValue

Returns: \Checkbox

setLabel()

Set the label used for this element

Parameter Name	Type	Description
	$label
$label

Returns: \Element|\ElementInterface

setLabelAttributes()

Set the attributes to use with the label

Parameter Name	Type	Description
$labelAttributes	array

Returns: \Element|\ElementInterface

setLabelOption()

Set a single label optionn

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: \Element|\ElementInterface

setLabelOptions()

Set many label options at once

Implementation will decide if this will overwrite or merge.

Parameter Name	Type	Description
$arrayOrTraversable	array|\Traversable

Returns: \Element|\ElementInterface

setMessages()

Set a list of messages to report when validation fails

Parameter Name	Type	Description
$messages	array|\Traversable

Returns: \Element|\ElementInterface

setName()

Set value for name

Parameter Name	Type	Description
$name	string

Returns: \Element|\ElementInterface

setOption()

Set a single option for an element

Parameter Name	Type	Description
$key	string
$value	mixed

Returns: self

setOptions()

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

Parameter Name	Type	Description
$options	array|\Traversable

Returns: \Checkbox

setUncheckedValue()

Set the value to use when checkbox is unchecked

Parameter Name	Type	Description
	$uncheckedValue
$uncheckedValue

Returns: \Checkbox

setUseHiddenElement()

Do we render hidden element?

Parameter Name	Type	Description
$useHiddenElement	bool

Returns: \Checkbox

setValue()

Checks or unchecks the checkbox.

Parameter Name	Type	Description
$value	mixed	A

Returns: \Element

useHiddenElement()

Do we render hidden element?

Returns: bool