class ItemList extends UIAjaxComponent

Class ItemList

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
$link from UIAjaxComponent
protected string $js_class from UIAjaxComponent
protected array $js_options from UIAjaxComponent
protected array $css_classes from UIAjaxComponent
protected array $xui_payload from UIAjaxComponent
protected Item[] $items
protected Paging $pagination

Methods

__construct(bool $link_id = false)

UIComponent constructor.

init()

put your comment there.

set_mod(mixed $mod)

Set link to owning module

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

Set Variable / Option

set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

set_render_params(mixed $input_params = array())

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

set_marker_content(mixed $marker_content = false)

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

reset_marker_content()

restores original content of marker_content

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.

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

mixed
render_xtag_element()

No description

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

process()

dummy process method - may be overwritten

render()

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

string|Template
render_xui()

Actual rendering method - must be implemented by children.

process_xui()

No description

set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

add_url_parameter(mixed $key, mixed $value)

Adds a parameter to url parameter list.

add_dependency(string $dep_name, UIAjaxComponent $dep_obj)

Add a new UIAjaxComponent object and register it under a certain name this component will use that name to retrieve the object in order to interact with it

mixed
get_dependency($dep_name)

Returns a dependent object in order to interact with it

set_uid($uid)

No description

add_css_class($css_class)

Adds a custom css class to the root element of this component.

set_option(string $key, mixed $val)

Sets options. This options will be used in the JS element of this XUI class.

enable_periodical_update(int $interval)

Enables the periodical update via ajax.

set_items(array $items)

No description

set_pagination(Paging $pagination)

No description

Details

in UIComponent at line 59
__construct(bool $link_id = false)

UIComponent constructor.

Parameters

bool $link_id

in UIComponent at line 67
init()

put your comment there.

..

in UIComponent at line 84
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

in UIComponent 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

in UIComponent 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

in UIComponent 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

in UIComponent 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

in UIComponent at line 168
reset_marker_content()

restores original content of marker_content

in UIComponent at line 180
mixed get(mixed $var)

Get Variable / Option

Parameters

mixed $var

Return Value

mixed

in UIComponent 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

in UIComponent 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

in UIComponent at line 230
string parse_template_cb_wrapper(mixed $matches)

Parameters

mixed $matches

Return Value

string

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

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in UIComponent at line 264
mixed render_xtag_element()

Return Value

mixed

in UIComponent 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

in UIAjaxComponent at line 143
process()

dummy process method - may be overwritten

in UIAjaxComponent at line 177
render()

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

Exceptions

Exception

at line 64
protected string|Template render_xui()

Actual rendering method - must be implemented by children.

Returns a template or a string containing the HTML of the element's content.

Return Value

string|Template

at line 38
protected process_xui()

in UIAjaxComponent at line 64
set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

Parameters

array $parameters

in UIAjaxComponent at line 74
add_url_parameter(mixed $key, mixed $value)

Adds a parameter to url parameter list.

Parameters

mixed $key
mixed $value

in UIAjaxComponent at line 86
add_dependency(string $dep_name, UIAjaxComponent $dep_obj)

Add a new UIAjaxComponent object and register it under a certain name this component will use that name to retrieve the object in order to interact with it

Parameters

string $dep_name
UIAjaxComponent $dep_obj

in UIAjaxComponent at line 97
mixed get_dependency($dep_name)

Returns a dependent object in order to interact with it

Parameters

$dep_name

Return Value

mixed

in UIAjaxComponent at line 104
set_uid($uid)

Parameters

$uid

in UIAjaxComponent at line 114
add_css_class($css_class)

Adds a custom css class to the root element of this component.

Parameters

$css_class

in UIAjaxComponent at line 125
set_option(string $key, mixed $val)

Sets options. This options will be used in the JS element of this XUI class.

Parameters

string $key update_interval (int) | hide_loading (bool)
mixed $val

in UIAjaxComponent at line 136
enable_periodical_update(int $interval)

Enables the periodical update via ajax.

The ajax calls will be execute after an interval of seconds passed by parameter one.

Parameters

int $interval

at line 24
set_items(array $items)

Parameters

array $items

at line 31
set_pagination(Paging $pagination)

Parameters

Paging $pagination