Faceted
class Faceted extends UIComponent
Constants
SYSTEM_TEMPLATE_UI_FOLDER |
|
Properties
Link | $xf_link | from UIComponent | |
string | $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
add new category for items beeing grouped by the short_id will be used as parameter
Return all active conditions
No description
Works only after process()
returns an array of all active items
Generates a unique dom id, dependent on the provided UID, as well as the current context.
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
Returns true if the passed item is currently active
No description
Process all parameters
Render XUI Object
Set Active Item
this class will be added to the outer wrapping div
Set Variable / Option for an array
name of the get parameter - default is uid_filter
sets marker_content to passed data -> restore original content with reset_marker_content()
this class will be added to the outer wrapping div
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
title displayed before the first category
No description
Details
in
UIComponent at line 64
__construct(string $link_id = null)
UIComponent constructor.
in
UIComponent at line 324
string
__toString()
No description
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
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
in
UIComponent at line 185
mixed
get($var)
Get Variable / Option
at line 256
array|Condition[]|string[]
getAllActiveConditions()
Return all active conditions
at line 274
array
getCurrentFilter()
No description
at line 300
mixed
get_active_value_for_category(string $category_short_id)
Works only after process()
at line 234
array
get_all_active_items(string|bool $category_short_id = false)
returns an array of all active items
at line 264
false|string[]
get_current_filter()
deprecated
deprecated
No description
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.
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
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
in
UIComponent at line 221
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 234
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 260
mixed|string
parse_xtag($xml_source)
No description
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
in
UIComponent at line 173
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 106
void
set(mixed $var, mixed $value = false)
Set Variable / Option
at line 355
set_active(mixed $category_short_id, mixed $item_value, mixed $overwrite = false)
Set Active Item
at line 326
set_additional_class(string $additional_class)
this class will be added to the outer wrapping div
in
UIComponent at line 122
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 344
set_get_parameter_name(string $get_parameter_name)
name of the get parameter - default is uid_filter
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()
in
UIComponent at line 90
set_mod(mixed $mod)
Set link to owning module
at line 335
set_render_mode(string $mode = 'classic')
this class will be added to the outer wrapping div
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)
at line 317
set_title(string $title)
title displayed before the first category
at line 308
set_xui_target($xui_target)
No description