Class Giscuit_Form_Element_Checkbox

Description

Checkbox element

  • copyright: Copyright (c) 2012 VEC

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

Zend_Form_Element_Checkbox
   |
   --Giscuit_Form_Element_Checkbox
Variable Summary
 bool $checked
 string $helper
 array $options
 string $_value
Method Summary
 getCheckedValue () string
 getUncheckedValue () string
 isChecked () bool
 setChecked (bool $flag) Zend_Form_Element_Checkbox
 setCheckedValue (string $value) Zend_Form_Element_Checkbox
 setOptions ( $options) Zend_Form_Element_Checkbox
 setUncheckedValue (string $value) Zend_Form_Element_Checkbox
 setValue (mixed $value) Zend_Form_Element_Checkbox
Variables
bool $checked = false (line 29)

Is the checkbox checked?

  • access: public
string $helper = 'formCheckbox' (line 35)

Use formCheckbox view helper by default

  • access: public
array $options = array(
'checkedValue' => '1',
'uncheckedValue' => '0',
)
(line 41)

Options that will be passed to the view helper

  • access: public
string $_checkedValue = '1' (line 50)

Value when checked

  • access: protected
string $_uncheckedValue = '0' (line 56)

Value when not checked

  • access: protected
string $_value = '0' (line 62)

Current value

  • var: 0 or 1
  • access: protected
Methods
getCheckedValue (line 137)

Get value when checked

  • access: public
string getCheckedValue ()
getUncheckedValue (line 160)

Get value when not checked

  • access: public
string getUncheckedValue ()
isChecked (line 187)

Get checked flag

  • access: public
bool isChecked ()
setChecked (line 171)

Set checked flag

  • access: public
Zend_Form_Element_Checkbox setChecked (bool $flag)
  • bool $flag
setCheckedValue (line 125)

Set checked value

  • access: public
Zend_Form_Element_Checkbox setCheckedValue (string $value)
  • string $value
setOptions (line 73)

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
setUncheckedValue (line 148)

Set unchecked value

  • access: public
Zend_Form_Element_Checkbox setUncheckedValue (string $value)
  • string $value
setValue (line 107)

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

Documentation generated on Fri, 23 Nov 2012 13:01:10 +0000 by phpDocumentor 1.4.3