Zend_Form_Element_Checkbox Class Reference

Public Member Functions
	setOptions (array $options)
	Set options.
	setValue ($value)
	Set value.
	setCheckedValue ($value)
	Set checked value.
	getCheckedValue ()
	Get value when checked.
	setUncheckedValue ($value)
	Set unchecked value.
	getUncheckedValue ()
	Get value when not checked.
	setChecked ($flag)
	Set checked flag.
	isChecked ()
	Get checked flag.

Public Attributes
	$checked = false
	$helper = 'formCheckbox'
	$options

Protected Attributes
	$_checkedValue = '1'
	$_uncheckedValue = '0'
	$_value = '0'

Additional Inherited Members
Static Public Member Functions inherited from Zend_Form_Element
static	resolveElementId (Zend_Form_Decorator_Interface $decorator)
	Used to resolve and return an element ID.
Protected Member Functions inherited from Zend_Form_Element
	_filterValue (&$value, &$key)
	Filter a value.
	_getDecorator ($name, $options)
	Instantiate a decorator based on class name or class name fragment.
	_loadFilter (array $filter)
	Lazy-load a filter.
	_loadValidator (array $validator)
	Lazy-load a validator.
	_loadDecorator (array $decorator, $name)
	Lazy-load a decorator.
	_getErrorMessages ()
	Retrieve error messages and perform translation and value substitution.
	_hasErrorMessages ()
	Are there custom error messages registered?

Member Function Documentation

getCheckedValue

(

)

Get value when checked.

Returns

string

getUncheckedValue

(

)

Get value when not checked.

Returns

string

isChecked

(

)

Get checked flag.

Returns

bool

setChecked

(

$flag

)

Set checked flag.

Parameters

bool

$flag

Returns

Zend_Form_Element_Checkbox

setCheckedValue

(

$value

)

Set checked value.

Parameters

string

$value

Returns

Zend_Form_Element_Checkbox

setOptions

(

array

$options

)

Set options.

Intercept checked and unchecked values and set them early; test stored value against checked and unchecked values after configuration.

Parameters

array

$options

Returns

Zend_Form_Element_Checkbox

setUncheckedValue

(

$value

)

Set unchecked value.

Parameters

string

$value

Returns

Zend_Form_Element_Checkbox

setValue

(

$value

)

Set value.

If value matches checked value, sets to that value, and sets the checked flag to true.

Any other value causes the unchecked value to be set as the current value, and the checked flag to be set as false.

Parameters

mixed

$value

Returns

Zend_Form_Element_Checkbox

Member Data Documentation

$_checkedValue = '1'

protected

$_uncheckedValue = '0'

protected

$_value = '0'

protected

$checked = false

$helper = 'formCheckbox'

$options

Initial value:

= array(
        'checkedValue'   => '1',
        'uncheckedValue' => '0',
    )