class UIComponent

Class UIComponent Parent class for all User Interface Helpers (XUI)

Constants

SYSTEM_TEMPLATE_UI_FOLDER

Properties

$xf_link
$link_id
array $GPvars
Controller $mod
protected array $local_template_marker
protected bool $_overwrite_param_array
protected bool|array|ModelCollection $marker_content
string $mod_object_manager
protected bool $_orig_marker_content
protected array $_allowed_params_filter
string $unique_dom_id
protected string $uid

Methods

__construct(string $link_id = null)

UIComponent constructor.

mixed
get(mixed $var)

Get Variable / Option

string
get_unique_dom_id()

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

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.

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

No description

string
parse_template_cb_wrapper(mixed $matches)

No description

mixed|string
parse_xtag($xml_source)

No description

process()

Declared in Classes

render()

No description

mixed
render_xtag_element()

No description

reset_marker_content()

restores original content of marker_content

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

Set Variable / Option

set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

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_params(mixed $input_params = array())

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

Details

at line 59
__construct(string $link_id = null)

UIComponent constructor.

Parameters

string $link_id

at line 180
mixed get(mixed $var)

Get Variable / Option

Parameters

mixed $var

Return Value

mixed

at line 197
string get_unique_dom_id()

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

Return Value

string

at line 285
Template 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

Exceptions

Exception

at line 67
init()

put your comment there.

..

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

Parameters

string $template_content HTML Template
array|bool $marker_array Markers and Values

Return Value

string Parsed HTML Content

at line 230
string parse_template_cb_wrapper(mixed $matches)

Parameters

mixed $matches

Return Value

string

at line 256
mixed|string parse_xtag($xml_source)

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

at line 320
process()

Declared in Classes

at line 321
render()

at line 264
mixed render_xtag_element()

Return Value

mixed

at line 168
reset_marker_content()

restores original content of marker_content

at line 100
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

at line 116
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

at line 159
set_marker_content(mixed $marker_content = false)

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

Parameters

mixed $marker_content

at line 84
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

at line 129
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