class Faceted extends UIComponent

Constants

SYSTEM_TEMPLATE_UI_FOLDER

Properties

$xf_link from  UIComponent
$link_id from  UIComponent
array $GPvars from  UIComponent
Controller $mod from  UIComponent
protected array $local_template_marker from  UIComponent
protected bool $_overwrite_param_array from  UIComponent
protected bool|array|ModelCollection $marker_content from  UIComponent
string $mod_object_manager from  UIComponent
protected bool $_orig_marker_content from  UIComponent
protected array $_allowed_params_filter from  UIComponent
string $unique_dom_id from  UIComponent
protected string $uid from  UIComponent
string read-only $_content

When used in template this property will contain the XML/HTML within the XUI Nodes

from  UIComponent

Methods

__construct(string $link_id = null)

UIComponent constructor.

string
__toString()

No description

string
add_category(string $label, string $short_id, bool $auto_add_all_item = false, bool $as_combobox = false, bool $collapsable = false, string|null $moreLink = null)

add new category for items beeing grouped by the short_id will be used as parameter

bool
add_item(string $category_short_id, string $label, string $value, string|Condition $condition = null, bool $active = false, int $indent = 0)

add an item to the faceted. The category, this item belongs to has to be added before

mixed
get($var)

Get Variable / Option

array|Condition[]|string[]
getAllActiveConditions()

Return all active conditions

array
getCurrentFilter()

No description

mixed
get_active_value_for_category(string $category_short_id)

Works only after process()

array
get_all_active_items(string|bool $category_short_id = false)

returns an array of all active items

false|string[]
get_current_filter() deprecated

No description

string
get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Template|null
get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

init()

put your comment there.

bool
is_active(mixed $category_short_id, mixed $item_value)

Returns true if the passed item is currently active

string
parse_template(string $template_content, array|bool $marker_array = false)

No description

string|null
parse_template_cb_wrapper(mixed $matches)

No description

mixed|string
parse_xtag($xml_source)

No description

process()

Process all parameters

render()

Render XUI Object

mixed
render_xtag_element()

No description

void
reset_marker_content()

restores original content of marker_content

void
set(mixed $var, mixed $value = false)

Set Variable / Option

set_active(mixed $category_short_id, mixed $item_value, mixed $overwrite = false)

Set Active Item

set_additional_class(string $additional_class)

this class will be added to the outer wrapping div

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

set_get_parameter_name(string $get_parameter_name)

name of the get parameter - default is uid_filter

void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

set_mod(mixed $mod)

Set link to owning module

set_render_mode(string $mode = 'classic')

this class will be added to the outer wrapping div

void
set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

set_title(string $title)

title displayed before the first category

set_xui_target($xui_target)

No description

Details

in UIComponent at line 64
__construct(string $link_id = null)

UIComponent constructor.

Parameters

string $link_id

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 400
string add_category(string $label, string $short_id, bool $auto_add_all_item = false, bool $as_combobox = false, bool $collapsable = false, string|null $moreLink = null)

add new category for items beeing grouped by the short_id will be used as parameter

Parameters

string $label
string $short_id

has to be unique

bool $auto_add_all_item

add an item "All" to the category

bool $as_combobox

Display a SELECT Field?

bool $collapsable

category will collapse if no entry is selected. can be expanded with js

string|null $moreLink

Additional link displayed below the facets

Return Value

string

$short_id

at line 432
bool add_item(string $category_short_id, string $label, string $value, string|Condition $condition = null, bool $active = false, int $indent = 0)

add an item to the faceted. The category, this item belongs to has to be added before

Parameters

string $category_short_id
string $label
string $value
string|Condition $condition

e.q "id = 1"

bool $active

Is Item selected?

int $indent

Return Value

bool

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 256
array|Condition[]|string[] getAllActiveConditions()

Return all active conditions

Return Value

array|Condition[]|string[]

at line 274
array getCurrentFilter()

No description

Return Value

array

= [[$categoryID => $currentFilterValue]]

at line 300
mixed get_active_value_for_category(string $category_short_id)

Works only after process()

Parameters

string $category_short_id

Return Value

mixed

at line 234
array get_all_active_items(string|bool $category_short_id = false)

returns an array of all active items

Parameters

string|bool $category_short_id

If set checks only the status of that category

Return Value

array

at line 264
false|string[] get_current_filter() deprecated

deprecated Use getCurrentfilter()

No description

Return Value

false|string[]

in UIComponent at line 202
string get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Return Value

string

in UIComponent at line 289
Template|null get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

in UIComponent at line 72
init()

put your comment there.

..

at line 382
bool is_active(mixed $category_short_id, mixed $item_value)

Returns true if the passed item is currently active

Parameters

mixed $category_short_id
mixed $item_value

Return Value

bool

in UIComponent at line 221
string parse_template(string $template_content, array|bool $marker_array = false)

No description

Parameters

string $template_content

HTML Template

array|bool $marker_array

Markers and Values

Return Value

string

Parsed HTML Content

in UIComponent at line 234
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

in UIComponent at line 260
mixed|string parse_xtag($xml_source)

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

at line 41
process()

Process all parameters

at line 78
render()

Render XUI Object

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

in UIComponent at line 106
void set(mixed $var, mixed $value = false)

Set Variable / Option

Parameters

mixed $var

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)

mixed $value

Value of Variable

Return Value

void

at line 355
set_active(mixed $category_short_id, mixed $item_value, mixed $overwrite = false)

Set Active Item

Parameters

mixed $category_short_id
mixed $item_value
mixed $overwrite

at line 326
set_additional_class(string $additional_class)

this class will be added to the outer wrapping div

Parameters

string $additional_class

in UIComponent at line 122
void set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

Parameters

mixed $member_array

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)

mixed $vars

Value of Variable

Return Value

void

at line 344
set_get_parameter_name(string $get_parameter_name)

name of the get parameter - default is uid_filter

Parameters

string $get_parameter_name

in UIComponent at line 165
void set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

at line 335
set_render_mode(string $mode = 'classic')

this class will be added to the outer wrapping div

Parameters

string $mode

= classic, horizontal

in UIComponent at line 135
void set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

Parameters

mixed $input_params

Return Value

void

at line 317
set_title(string $title)

title displayed before the first category

Parameters

string $title

at line 308
set_xui_target($xui_target)

No description

Parameters

$xui_target