Public Member Functions | Static Public Attributes

FormControlAggregate Class Reference

Inheritance diagram for FormControlAggregate:
Collaboration diagram for FormControlAggregate:

List of all members.

Public Member Functions

 _extend ()
 pre_out ()
 set_selector ($class)
 get (Theme $theme)
 set_label_id ($id)
 get_label_id ()
 get_visualizer ()
 label ($label)
 process ()

Static Public Attributes

static $outpre = false

Detailed Description

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

Definition at line 8 of file formcontrolaggregate.php.


Member Function Documentation

FormControlAggregate::_extend (  ) 

Called upon construct. Sets control properties

Reimplemented from FormControl.

Definition at line 15 of file formcontrolaggregate.php.

FormControlAggregate::get ( Theme theme  ) 

Render this control Ensures that this control has an id property

Parameters:
Theme $theme The theme used to render the control
Returns:
string The HTML output of the control

Reimplemented from FormControl.

Definition at line 101 of file formcontrolaggregate.php.

FormControlAggregate::get_label_id (  ) 

Returns the ID of any wrapping label

Returns:
null|string

Definition at line 123 of file formcontrolaggregate.php.

FormControlAggregate::get_visualizer (  ) 

Provide the HTML id of the visualizer element, which is different from the input element that provides a value

Reimplemented from FormControl.

Definition at line 135 of file formcontrolaggregate.php.

FormControlAggregate::label ( label  ) 

Shortcut to wrap this control in a label This version for this control defaults to use the control.label.outsideright template

Parameters:
string $label The caption of the label
Returns:
FormControlLabel The label control is returned. FYI, THIS BREAKS THE FLUENT INTERFACE.

Reimplemented from FormControl.

Definition at line 145 of file formcontrolaggregate.php.

Referenced by pre_out().

FormControlAggregate::pre_out (  ) 

Return the HTML/script required for this control. Do it only once.

Returns:
string The HTML/javascript required for this control.

Reimplemented from FormControl.

Definition at line 25 of file formcontrolaggregate.php.

FormControlAggregate::process (  ) 

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

Reimplemented from FormControl.

Definition at line 153 of file formcontrolaggregate.php.

FormControlAggregate::set_label_id ( id  ) 

Set the HTML id of the label to change when the aggregation value changes

Parameters:
string $id The HTML id of the label to update
Returns:
FormControlAggregate $this

Definition at line 113 of file formcontrolaggregate.php.

FormControlAggregate::set_selector ( class  ) 

Set the selector used to find checkboxes whose values should be aggregated

Parameters:
string $class The CSS selector to use for aggregation
Returns:
FormControlAggregate $this

Definition at line 90 of file formcontrolaggregate.php.


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