Form/Element/Checkbox.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Form
- Subpackage
- Element
\Zend_Form_Element_Checkbox
Package: Zend_Form\Element
Returns
Returns
Checkbox form element
- Parent(s)
- \Zend_Form_Element_Xhtml < \Zend_Form_Element
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Version
- $Id$
Properties
string $_checkedValue = '1'Value when checked
Default value
'1'Details- Type
- string
string $_uncheckedValue = '0'Value when not checked
Default value
'0'Details- Type
- string
string $_value = '0'Current value
Default value
'0'Details- Type
- string
bool $checked = falseIs the checkbox checked?
Default value
falseDetails- Type
- bool
string $helper = 'formCheckbox'Use formCheckbox view helper by default
Default value
'formCheckbox'Details- Type
- string
array $options = array('checkedValue' => '1', 'uncheckedValue' => '0')Options that will be passed to the view helper
Default value
array('checkedValue' => '1', 'uncheckedValue' => '0')Details- Type
- array
Methods
getCheckedValue() : stringGet value when checked
Returns
| Type | Description |
|---|---|
| string |
getUncheckedValue() : stringGet value when not checked
Returns
| Type | Description |
|---|---|
| string |
isChecked() : boolGet checked flag
Returns
| Type | Description |
|---|---|
| bool |
setChecked(bool $flag) : \Zend_Form_Element_CheckboxSet checked flag
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_Form_Element_Checkbox |
setCheckedValue(string $value) : \Zend_Form_Element_CheckboxSet checked value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Form_Element_Checkbox |
setOptions(array $options) : \Zend_Form_Element_CheckboxSet options
Intercept checked and unchecked values and set them early; test stored
value against checked and unchecked values after configuration.
Parameters| Name | Type | Description |
|---|---|---|
| $options | array |
| Type | Description |
|---|---|
| \Zend_Form_Element_Checkbox |
setUncheckedValue(string $value) : \Zend_Form_Element_CheckboxSet unchecked value
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Form_Element_Checkbox |
setValue(mixed $value) : \Zend_Form_Element_CheckboxSet 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| Name | Type | Description |
|---|---|---|
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Form_Element_Checkbox |