Dojo/Form/Element/CheckBox.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Dojo
- subpackage
- Form_Element
- Classes
- Zend_Dojo_Form_Element_CheckBox
Description
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.
Zend_Dojo_Form_Element_CheckBox
- Extends from
- Zend_Dojo_Form_Element_Dijit
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_Dojo
- subpackage
- Form_Element
- uses
- Zend_Dojo_Form_Element_Dijit
- version
- $Id: CheckBox.php 20096 2010-01-06 02:05:09Z bkarwin $
- Properties
- $checked
- $helper
- $options
- $_checkedValue
- $_uncheckedValue
- $_value
- Methods
- setOptions
- setValue
- setCheckedValue
- getCheckedValue
- setUncheckedValue
- getUncheckedValue
- setChecked
- isChecked
Description
CheckBox dijit
Note: this would be easier with mixins or traits...
Properties
$_checkedValue
string $_checkedValue = '1'Value when checked
Details
- $_checkedValue
- string
- visibility
- protected
- default
- 1
- final
- false
- static
- false
$_uncheckedValue
string $_uncheckedValue = '0'Value when not checked
Details
- $_uncheckedValue
- string
- visibility
- protected
- default
- 0
- final
- false
- static
- false
$_value
string $_value = '0'Current value
Details
- $_value
- string
0 or 1 - visibility
- protected
- default
- 0
- final
- false
- static
- false
$checked
bool $checked = 'false'Is the checkbox checked?
Details
- $checked
- bool
- visibility
- public
- default
- false
- final
- false
- static
- false
$helper
string $helper = 'CheckBox'Use formCheckbox view helper by default
Details
- $helper
- string
- visibility
- public
- default
- CheckBox
- final
- false
- static
- false
$options
array $options = 'array'Options that will be passed to the view helper
Details
- $options
- array
- visibility
- public
- default
- array
- final
- false
- static
- false
Methods
getCheckedValue
getCheckedValue(
)
:
stringGet value when checked
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
getUncheckedValue
getUncheckedValue(
)
:
stringGet value when not checked
Output
- string
Details
- visibility
- public
- final
- false
- static
- false
isChecked
isChecked(
)
:
boolGet checked flag
Output
- bool
Details
- visibility
- public
- final
- false
- static
- false
setChecked
setChecked(
bool $flag
)
:
Zend_Form_Element_CheckboxSet checked flag
Arguments
- $flag
- bool
Output
Details
- visibility
- public
- final
- false
- static
- false
setCheckedValue
setCheckedValue(
string $value
)
:
Zend_Form_Element_CheckboxSet checked value
Arguments
- $value
- string
Output
Details
- visibility
- public
- final
- false
- static
- false
setOptions
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.
Arguments
- $options
- array
Output
Details
- visibility
- public
- final
- false
- static
- false
setUncheckedValue
setUncheckedValue(
string $value
)
:
Zend_Form_Element_CheckboxSet unchecked value
Arguments
- $value
- string
Output
Details
- visibility
- public
- final
- false
- static
- false
setValue
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.
Arguments
- $value
- mixed
Output
Details
- visibility
- public
- final
- false
- static
- false