Public Member Functions | Public Attributes

FormControlCheckbox Class Reference

Inheritance diagram for FormControlCheckbox:
Collaboration diagram for FormControlCheckbox:

List of all members.

Public Member Functions

 _extend ()
 get (Theme $theme)
 process ()
 set_returned_value ($returned_value)
 set_value ($value, $manually=true)

Public Attributes

 $returned_value

Detailed Description

A checkbox control based on FormControl for output via a FormUI.

Definition at line 8 of file formcontrolcheckbox.php.


Member Function Documentation

FormControlCheckbox::_extend (  ) 

Called upon construct. Sets control properties

Reimplemented from FormControl.

Definition at line 15 of file formcontrolcheckbox.php.

FormControlCheckbox::get ( Theme theme  ) 

Produce the control for display

Parameters:
Theme $theme The theme that will be used to render the template
Returns:
string The output of the template

Reimplemented from FormControl.

Definition at line 27 of file formcontrolcheckbox.php.

FormControlCheckbox::process (  ) 

Obtain the value of this control as supplied by the incoming $_POST values

Reimplemented from FormControl.

Definition at line 43 of file formcontrolcheckbox.php.

FormControlCheckbox::set_returned_value ( returned_value  ) 

Set the value returned when this control is checked

Parameters:
mixed $returned_value The value returned when the value of this control is true;
Returns:
FormControlCheckbox $this

Definition at line 58 of file formcontrolcheckbox.php.

FormControlCheckbox::set_value ( value,
manually = true 
)

Set the value of the control

Parameters:
mixed $value The initial value of the control
bool $manually True if the value was set manually in code rather than being submitted
Returns:
FormControl $this

Reimplemented from FormControl.

Definition at line 64 of file formcontrolcheckbox.php.


The documentation for this class was generated from the following file: