class Browse extends UIAjaxComponent

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
$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 bool $deferredLoading from  UIAjaxComponent
protected bool $deferredLoadingMessage from  UIAjaxComponent

Methods

__construct(string $link_id = null)

UIComponent constructor.

string
__toString()

No description

add_css_class($css_class)

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

add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)

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.

add_url_parameter(mixed $key, mixed $value)

Adds a parameter to url parameter list.

add_viewmode(string $viewmode_name, Template $viewmode_tpl)

Add an additional viewmode to the xui. You must provide the name of the viewmode (usually "details" or "gallery"), as well as a template that will be used to render the content of an element for the viewmode.

enable_periodical_update(int $interval)

Enables the periodical update via ajax.

mixed
get($var)

Get Variable / Option

string
getPlaceholderContent()

Returns a placeholder which is used to display while this component is loading the content.

mixed
get_dependency($dep_name)

Returns a dependent object in order to interact with it

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.

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()

dummy process method - may be overwritten

process_xui()

Process the input as preparation to the render process

render()

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

mixed
render_xtag_element()

No description

string|Template
render_xui()

Render the actual browse content

void
reset_marker_content()

restores original content of marker_content

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

Set Variable / Option

void
setDeferredLoading(bool $bool, string $message = '')

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

set_column_count(int $column_count)

Set the number of columns to be displayed

set_data_query(string $data_query, int $query_cache_ttl = false)

The prepared statement to retrieve the content to be browsed through.

set_enable_ajax(bool $enable_ajax)

Enable or disable ajax loading for pagination and letter access.

set_entries_per_page(int $entries_per_page)

Set the number of entries displayed per pagination page.

set_group_column(mixed $group_column)

The column by which to group and order the found entries

set_item_link_cb(mixed $item_link_cb)

Defines a link callback that will be used to create the link in the list viewmode.

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_option(string $key, mixed $val)

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

void
set_render_params(mixed $input_params = array())

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

set_show_filter(bool $show_filter)

Should a text filter be displayed?

set_show_letters(bool $show_letters)

Should a letter filter be displayed? All letters that have entries will be marked accordingly

set_uid($uid)

No description

set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

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

in UIAjaxComponent at line 139
add_css_class($css_class)

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

Parameters

$css_class

in UIAjaxComponent at line 106
add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)

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
bool $reloadOnUpdate

Set true to reload dependency if this component is updated.

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

Adds a parameter to url parameter list.

Parameters

mixed $key
mixed $value

at line 92
add_viewmode(string $viewmode_name, Template $viewmode_tpl)

Add an additional viewmode to the xui. You must provide the name of the viewmode (usually "details" or "gallery"), as well as a template that will be used to render the content of an element for the viewmode.

Parameters

string $viewmode_name
Template $viewmode_tpl

in UIAjaxComponent at line 161
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

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

in UIAjaxComponent at line 200
protected string getPlaceholderContent()

Returns a placeholder which is used to display while this component is loading the content.

Return Value

string

in UIAjaxComponent at line 122
mixed get_dependency($dep_name)

Returns a dependent object in order to interact with it

Parameters

$dep_name

Return Value

mixed

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.

..

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

in UIAjaxComponent at line 168
process()

dummy process method - may be overwritten

at line 122
protected process_xui()

Process the input as preparation to the render process

in UIAjaxComponent at line 214
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

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

at line 197
protected string|Template render_xui()

Render the actual browse content

Return Value

string|Template

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

in UIAjaxComponent at line 92
void setDeferredLoading(bool $bool, string $message = '')

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

Parameters

bool $bool
string $message

Return Value

void

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 28
set_column_count(int $column_count)

Set the number of columns to be displayed

Parameters

int $column_count

Default: 3

at line 105
set_data_query(string $data_query, int $query_cache_ttl = false)

The prepared statement to retrieve the content to be browsed through.

Make sure to provide at least one column "browse_column" that will be used as the column to group and order by

Parameters

string $data_query
int $query_cache_ttl

The amount of milliseconds all queries will be cached

at line 18
set_enable_ajax(bool $enable_ajax)

Enable or disable ajax loading for pagination and letter access.

Currently, AJAX for the filter component is not available

Parameters

bool $enable_ajax

Default: true

at line 69
set_entries_per_page(int $entries_per_page)

Set the number of entries displayed per pagination page.

If set to 0, pagination will be completely disabled and all items will be displayed on the same page

Parameters

int $entries_per_page

90

at line 38
set_group_column(mixed $group_column)

The column by which to group and order the found entries

Parameters

mixed $group_column

Default: the first letter of the browse_column

Defines a link callback that will be used to create the link in the list viewmode.

As a parameter, the entire row of the result will be provided as an assoc array

Parameters

mixed $item_link_cb

The callback

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

in UIAjaxComponent at line 150
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 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 58
set_show_filter(bool $show_filter)

Should a text filter be displayed?

Parameters

bool $show_filter

Default: false

at line 48
set_show_letters(bool $show_letters)

Should a letter filter be displayed? All letters that have entries will be marked accordingly

Parameters

bool $show_letters

Default: false

in UIAjaxComponent at line 129
set_uid($uid)

No description

Parameters

$uid

in UIAjaxComponent at line 70
set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

Parameters

array $parameters