Zend Framework
Back to top  

 Methods

__construct() 

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

inherited_from \Zend\Form\Element::__construct()
inherited_from \Zend\Form\Element\Checkbox::__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()
inherited_from \Zend\Form\Element\Checkbox::clearAttributes()

Returns

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

Clear all label options

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

inherited_from \Zend\Form\Element::clearLabelOptions()
inherited_from \Zend\Form\Element\Checkbox::clearLabelOptions()

Returns

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

Get the disable in array validator flag.

disableInArrayValidator() : bool

Returns

bool

Retrieve a single element attribute

getAttribute($key) : mixed | null
Inherited

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

Parameters

$key

Returns

mixednull

Retrieve all attributes at once

getAttributes() : array | \Traversable
Inherited

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

Returns

array\Traversable

Get the value to use when checkbox is checked

getCheckedValue() : string
Inherited

inherited_from \Zend\Form\Element\Checkbox::getCheckedValue()

Returns

string

Provide default input rules for this element

getInputSpecification() : array
Inherited

Attaches the captcha as a validator.

inherited_from \Zend\Form\Element\Checkbox::getInputSpecification()

Returns

array

Retrieve the label used for this element

getLabel() : null | string
Inherited

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

Returns

nullstring

Get the attributes to use with the label

getLabelAttributes() : array
Inherited

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

Returns

array

Retrieve a single label option

getLabelOption($key) : mixed | null
Inherited

inherited_from \Zend\Form\Element::getLabelOption()
inherited_from \Zend\Form\Element\Checkbox::getLabelOption()

Parameters

$key

Returns

mixednull

Get label specific options

getLabelOptions() : array
Inherited

inherited_from \Zend\Form\Element::getLabelOptions()
inherited_from \Zend\Form\Element\Checkbox::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\Element::getMessages()
inherited_from \Zend\Form\Element\Checkbox::getMessages()

Returns

array\Traversable

Get value for name

getName() : string | int
Inherited

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

Returns

stringint

Return the specified option

getOption(string $option) : NULL | mixed
Inherited

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

Parameters

$option

string

Returns

NULLmixed

Get defined options

getOptions() : array
Inherited

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

Returns

array

Get the value to use when checkbox is unchecked

getUncheckedValue() : string
Inherited

inherited_from \Zend\Form\Element\Checkbox::getUncheckedValue()

Returns

string

Retrieve the element value

getValue() : mixed
Inherited

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

Returns

mixed

getValueOptions() 

getValueOptions() : array

Returns

array

Does the element has a specific attribute ?

hasAttribute(string $key) : bool
Inherited

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

Parameters

$key

string

Returns

bool

Does the element has a specific label option ?

hasLabelOption(string $key) : bool
Inherited

inherited_from \Zend\Form\Element::hasLabelOption()
inherited_from \Zend\Form\Element\Checkbox::hasLabelOption()

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()
inherited_from \Zend\Form\Element\Checkbox::init()

Checks if this checkbox is checked.

isChecked() : bool
Inherited

inherited_from \Zend\Form\Element\Checkbox::isChecked()

Returns

bool

Remove a single attribute

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

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

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

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

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

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

Remove a single label option

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

inherited_from \Zend\Form\Element::removeLabelOption()
inherited_from \Zend\Form\Element\Checkbox::removeLabelOption()

Parameters

$key

string

Returns

\Zend\Form\ElementInterface

Remove many attributes at once

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

inherited_from \Zend\Form\Element::removeLabelOptions()
inherited_from \Zend\Form\Element\Checkbox::removeLabelOptions()

Parameters

$keys

array

Returns

\Zend\Form\ElementInterface

Set a single element attribute

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

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\Element\MultiCheckbox\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\Element::setAttributes()
inherited_from \Zend\Form\Element\Checkbox::setAttributes()

Parameters

$arrayOrTraversable

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

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

Checks or unchecks the checkbox.

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

inherited_from \Zend\Form\Element\Checkbox::setChecked()

Parameters

$value

bool

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

inherited_from \Zend\Form\Element\Checkbox::setCheckedValue()

Parameters

$checkedValue

Returns

\Zend\Form\Element\Checkbox

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

setDisableInArrayValidator(bool $disableOption) : \Zend\Form\Element\Select

Parameters

$disableOption

bool

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\Element::setLabel()
inherited_from \Zend\Form\Element\Checkbox::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\Element::setLabelAttributes()
inherited_from \Zend\Form\Element\Checkbox::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\Element::setLabelOption()
inherited_from \Zend\Form\Element\Checkbox::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\Element::setLabelOptions()
inherited_from \Zend\Form\Element\Checkbox::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\Element::setMessages()
inherited_from \Zend\Form\Element\Checkbox::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\Element::setName()
inherited_from \Zend\Form\Element\Checkbox::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\self
Inherited

inherited_from \Zend\Form\Element::setOption()
inherited_from \Zend\Form\Element\Checkbox::setOption()

Parameters

$key

string

$value

mixed

Returns

\Zend\Form\self

Set options for an element.

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

Accepted options are: - label: label to associate with the element - label_attributes: attributes to use when the label is rendered - value_options: list of values and labels for the select options

Parameters

$options

array\Traversable

Exceptions

\Zend\Form\Exception\InvalidArgumentException

Returns

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

Set the value to use when checkbox is unchecked

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

inherited_from \Zend\Form\Element\Checkbox::setUncheckedValue()

Parameters

$uncheckedValue

Returns

\Zend\Form\Element\Checkbox

Do we render hidden element?

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

inherited_from \Zend\Form\Element\Checkbox::setUseHiddenElement()

Parameters

$useHiddenElement

bool

Returns

\Zend\Form\Element\Checkbox

Sets the value that should be selected.

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

Parameters

$value

mixed

The value to set.

Returns

\Zend\Form\Element\MultiCheckbox

setValueOptions() 

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

Parameters

$options

array

Returns

\Zend\Form\Element\MultiCheckbox

unsetValueOption() 

unsetValueOption(string $key) : \Zend\Form\Element\self

Parameters

$key

string

Returns

\Zend\Form\Element\self

Do we render hidden element?

useHiddenElement() : bool
Inherited

inherited_from \Zend\Form\Element\Checkbox::useHiddenElement()

Returns

bool

Get validator

getValidator() : \Zend\Validator\ValidatorInterface

Returns

\Zend\Validator\ValidatorInterface

Get only the values from the options attribute

getValueOptionsValues() : array

Returns

array

 Properties

 

Seed attributes

$attributes : array

 

$checkedValue

$checkedValue : string
Inherited

inherited_from \Zend\Form\Element\Checkbox::$$checkedValue
 

$disableInArrayValidator

$disableInArrayValidator : bool

 

$label

$label : null | string
Inherited

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

$labelAttributes

$labelAttributes : array
Inherited

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

Label specific options

$labelOptions : array
Inherited

inherited_from \Zend\Form\Element::$$labelOptions
inherited_from \Zend\Form\Element\Checkbox::$$labelOptions
 

<p>Validation error messages</p>

$messages : array
Inherited

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

<p>custom options</p>

$options : array
Inherited

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

$uncheckedValue

$uncheckedValue : string

 

$useHiddenElement

$useHiddenElement : bool

 

$validator

$validator : \Zend\Validator\ValidatorInterface
Inherited

inherited_from \Zend\Form\Element\Checkbox::$$validator
 

$value

$value : mixed
Inherited

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

$valueOptions

$valueOptions : array