PHP Class Habari\FormControlAggregate

Inheritance: extends FormControl
Datei anzeigen Open project: habari/system

Public Properties

Property Type Description
$outpre

Public Methods

Method Description
_extend ( ) Called upon construct. Sets control properties
get ( Theme $theme ) : string Render this control Ensures that this control has an id property
get_label_id ( ) : null | string Returns the ID of any wrapping label
get_visualizer ( ) Provide the HTML id of the visualizer element, which is different from the input element that provides a value
label ( string $label ) : FormControlLabel Shortcut to wrap this control in a label This version for this control defaults to use the control.label.outsideright template
pre_out ( ) : string Return the HTML/script required for this control. Do it only once.
process ( ) Obtain the value of this control as supplied by the incoming $_POST values
set_label_id ( string $id ) : FormControlAggregate Set the HTML id of the label to change when the aggregation value changes
set_selector ( string $class ) : FormControlAggregate Set the selector used to find checkboxes whose values should be aggregated

Method Details

_extend() public method

Called upon construct. Sets control properties
public _extend ( )

get() public method

Render this control Ensures that this control has an id property
public get ( Theme $theme ) : string
$theme Theme The theme used to render the control
return string The HTML output of the control

get_label_id() public method

Returns the ID of any wrapping label
public get_label_id ( ) : null | string
return null | string

get_visualizer() public method

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

label() public method

Shortcut to wrap this control in a label This version for this control defaults to use the control.label.outsideright template
public label ( string $label ) : FormControlLabel
$label string The caption of the label
return FormControlLabel The label control is returned. FYI, THIS BREAKS THE FLUENT INTERFACE.

pre_out() public method

Return the HTML/script required for this control. Do it only once.
public pre_out ( ) : string
return string The HTML/javascript required for this control.

process() public method

Obtain the value of this control as supplied by the incoming $_POST values
public process ( )

set_label_id() public method

Set the HTML id of the label to change when the aggregation value changes
public set_label_id ( string $id ) : FormControlAggregate
$id string The HTML id of the label to update
return FormControlAggregate $this

set_selector() public method

Set the selector used to find checkboxes whose values should be aggregated
public set_selector ( string $class ) : FormControlAggregate
$class string The CSS selector to use for aggregation
return FormControlAggregate $this

Property Details

$outpre static_oe public_oe property

static public $outpre