Checkbox form element

• version: $Id: Checkbox.php 20096 2010-01-06 02:05:09Z bkarwin $
• copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
• license: New BSD License

Located in /Form/Element/Checkbox.php (line 35)

Zend_Form_Element
   |
   --Zend_Form_Element_Xhtml
      |
      --Zend_Form_Element_Checkbox

bool $checked = false (line 41)

Is the checkbox checked?

• access: public

string $helper = 'formCheckbox' (line 47)

Use formCheckbox view helper by default

• access: public

---

Redefinition of:

Zend_Form_Element::$helper

Default view helper to use

array $options = array(
'checkedValue' => '1',
'uncheckedValue' => '0',
) (line 53)

Options that will be passed to the view helper

• access: public

string $_checkedValue = '1' (line 62)

Value when checked

• access: protected

string $_uncheckedValue = '0' (line 68)

Value when not checked

• access: protected

string $_value = '0' (line 74)

Current value

• var: 0 or 1
• access: protected

---

Redefinition of:

Zend_Form_Element::$_value

Element value

Inherited Variables

Inherited from Zend_Form_Element

Zend_Form_Element::$_allowEmpty
Zend_Form_Element::$_autoInsertNotEmptyValidator
Zend_Form_Element::$_belongsTo
Zend_Form_Element::$_decorators
Zend_Form_Element::$_description
Zend_Form_Element::$_disableLoadDefaultDecorators
Zend_Form_Element::$_errorMessages
Zend_Form_Element::$_errorMessageSeparator
Zend_Form_Element::$_errors
Zend_Form_Element::$_filters
Zend_Form_Element::$_ignore
Zend_Form_Element::$_isArray
Zend_Form_Element::$_isError
Zend_Form_Element::$_isErrorForced
Zend_Form_Element::$_isPartialRendering
Zend_Form_Element::$_label
Zend_Form_Element::$_loaders
Zend_Form_Element::$_messages
Zend_Form_Element::$_name
Zend_Form_Element::$_order
Zend_Form_Element::$_required
Zend_Form_Element::$_translator
Zend_Form_Element::$_translatorDisabled
Zend_Form_Element::$_type
Zend_Form_Element::$_validatorRules
Zend_Form_Element::$_validators
Zend_Form_Element::$_view

getCheckedValue (line 149)

Get value when checked

• access: public

string getCheckedValue ()

getUncheckedValue (line 172)

Get value when not checked

• access: public

string getUncheckedValue ()

isChecked (line 199)

Get checked flag

• access: public

bool isChecked ()

setChecked (line 183)

Set checked flag

• access: public

Zend_Form_Element_Checkbox setChecked (bool $flag)

• bool $flag

setCheckedValue (line 137)

Set checked value

• access: public

Zend_Form_Element_Checkbox setCheckedValue (string $value)

• string $value

setOptions (line 85)

Set options

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

• access: public

Zend_Form_Element_Checkbox setOptions ( $options)

• array $options

---

Redefinition of:

Zend_Form_Element::setOptions()

Set object state from options array

setUncheckedValue (line 160)

Set unchecked value

• access: public

Zend_Form_Element_Checkbox setUncheckedValue (string $value)

• string $value

setValue (line 119)

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.

• access: public

Zend_Form_Element_Checkbox setValue (mixed $value)

• mixed $value

---

Redefinition of:

Zend_Form_Element::setValue()

Set element value

Inherited Methods

Inherited From Zend_Form_Element

Zend_Form_Element::__construct()
Zend_Form_Element::addDecorator()
Zend_Form_Element::addDecorators()
Zend_Form_Element::addError()
Zend_Form_Element::addErrorMessage()
Zend_Form_Element::addErrorMessages()
Zend_Form_Element::addErrors()
Zend_Form_Element::addFilter()
Zend_Form_Element::addFilters()
Zend_Form_Element::addPrefixPath()
Zend_Form_Element::addPrefixPaths()
Zend_Form_Element::addValidator()
Zend_Form_Element::addValidators()
Zend_Form_Element::autoInsertNotEmptyValidator()
Zend_Form_Element::clearDecorators()
Zend_Form_Element::clearErrorMessages()
Zend_Form_Element::clearFilters()
Zend_Form_Element::clearValidators()
Zend_Form_Element::filterName()
Zend_Form_Element::getAllowEmpty()
Zend_Form_Element::getAttrib()
Zend_Form_Element::getAttribs()
Zend_Form_Element::getBelongsTo()
Zend_Form_Element::getDecorator()
Zend_Form_Element::getDecorators()
Zend_Form_Element::getDescription()
Zend_Form_Element::getErrorMessages()
Zend_Form_Element::getErrorMessageSeparator()
Zend_Form_Element::getErrors()
Zend_Form_Element::getFilter()
Zend_Form_Element::getFilters()
Zend_Form_Element::getFullyQualifiedName()
Zend_Form_Element::getId()
Zend_Form_Element::getIgnore()
Zend_Form_Element::getLabel()
Zend_Form_Element::getMessages()
Zend_Form_Element::getName()
Zend_Form_Element::getOrder()
Zend_Form_Element::getPluginLoader()
Zend_Form_Element::getTranslator()
Zend_Form_Element::getType()
Zend_Form_Element::getUnfilteredValue()
Zend_Form_Element::getValidator()
Zend_Form_Element::getValidators()
Zend_Form_Element::getValue()
Zend_Form_Element::getView()
Zend_Form_Element::hasErrors()
Zend_Form_Element::hasTranslator()
Zend_Form_Element::init()
Zend_Form_Element::isArray()
Zend_Form_Element::isRequired()
Zend_Form_Element::isValid()
Zend_Form_Element::loadDefaultDecorators()
Zend_Form_Element::loadDefaultDecoratorsIsDisabled()
Zend_Form_Element::markAsError()
Zend_Form_Element::removeDecorator()
Zend_Form_Element::removeFilter()
Zend_Form_Element::removeValidator()
Zend_Form_Element::render()
Zend_Form_Element::setAllowEmpty()
Zend_Form_Element::setAttrib()
Zend_Form_Element::setAttribs()
Zend_Form_Element::setAutoInsertNotEmptyValidator()
Zend_Form_Element::setBelongsTo()
Zend_Form_Element::setConfig()
Zend_Form_Element::setDecorators()
Zend_Form_Element::setDescription()
Zend_Form_Element::setDisableLoadDefaultDecorators()
Zend_Form_Element::setDisableTranslator()
Zend_Form_Element::setErrorMessages()
Zend_Form_Element::setErrorMessageSeparator()
Zend_Form_Element::setErrors()
Zend_Form_Element::setFilters()
Zend_Form_Element::setIgnore()
Zend_Form_Element::setIsArray()
Zend_Form_Element::setLabel()
Zend_Form_Element::setName()
Zend_Form_Element::setOptions()
Zend_Form_Element::setOrder()
Zend_Form_Element::setPluginLoader()
Zend_Form_Element::setRequired()
Zend_Form_Element::setTranslator()
Zend_Form_Element::setValidators()
Zend_Form_Element::setValue()
Zend_Form_Element::setView()
Zend_Form_Element::translatorIsDisabled()
Zend_Form_Element::_filterValue()
Zend_Form_Element::_getDecorator()
Zend_Form_Element::_getErrorMessages()
Zend_Form_Element::_hasErrorMessages()
Zend_Form_Element::_loadDecorator()
Zend_Form_Element::_loadFilter()
Zend_Form_Element::_loadValidator()
Zend_Form_Element::__call()
Zend_Form_Element::__get()
Zend_Form_Element::__set()
Zend_Form_Element::__toString()

Inherited Constants

Inherited from Zend_Form_Element

Zend_Form_Element::DECORATOR
Zend_Form_Element::FILTER
Zend_Form_Element::VALIDATE