Public Member Functions | Static Public Attributes

FormControlFacet Class Reference

Inheritance diagram for FormControlFacet:
Collaboration diagram for FormControlFacet:

List of all members.

Public Member Functions

 _extend ()
 pre_out ()
 set_ajax ($url, $ishtml=false)
 get (Theme $theme)
 get_visualizer ()
 parse ()

Static Public Attributes

static $outpre

Detailed Description

A faceted search control based on FormControl for output via a FormUI.

Definition at line 8 of file formcontrolfacet.php.


Member Function Documentation

FormControlFacet::_extend (  ) 

Called upon construct. Sets control properties

Reimplemented from FormControl.

Definition at line 15 of file formcontrolfacet.php.

FormControlFacet::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 136 of file formcontrolfacet.php.

FormControlFacet::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 150 of file formcontrolfacet.php.

FormControlFacet::parse (  ) 

Parse the values of this field and return an array of key/value components. Example: $f->value = 'tag: "llamas" tag: feline alpaca'; var_dump($f->parsed()); // ['tag' => ['llamas', 'feline'], 'text' => ['alpaca']];

Returns:
array The array of parsed values

Definition at line 161 of file formcontrolfacet.php.

FormControlFacet::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 50 of file formcontrolfacet.php.

FormControlFacet::set_ajax ( url,
ishtml = false 
)

Set the URL to use for ajax callbacks. The callback needs to accept at least the search term as the POSTed parameter "q"

Parameters:
string $url The URL to submit the AJAX request to
bool $ishtml If true, the display response returned via AJAX is to be rendered as HTML (unescaped)
Returns:
FormControlAutocomplete $this

Definition at line 124 of file formcontrolfacet.php.


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