class AjaxContainer extends UIComponent

deprecated Use Container instead

Class AjaxContainer

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($id) deprecated

AjaxContainer constructor.

string
__toString()

No description

enable_fill_via_ajax(mixed $prefill, bool $default_style = false)

If fill via Ajax is enabled, the callback data is not included in the original template output put will be loaded using an ajax request right after the page has been loaded Use this feature to offload load intensive data queries

enable_periodical_update(mixed $interval)

Enable updating of container via AJAX all x seconds

enable_use_back_history()

No description

mixed
get($var)

Get Variable / Option

get_content()

Returns the content of this container. Calls callback if neccessary

get_reload_link($link_array = false)

Returns a link which reloads the container

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

No description

render()

Render Container with Content

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

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

set_content(mixed $content)

Set the content of the container to a static content (e.g. Template Object or HTML Output)

set_content_callback(mixed $callback, array|bool $parameters = false)

Set the content of the container by using a callback function

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

void
set_render_params(mixed $input_params = array())

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

set_url(mixed $url)

set url to call - if not set, it will be set by get_current_url

Details

at line 29
__construct($id) deprecated

deprecated Use Container instead

AjaxContainer constructor.

Parameters

$id

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 82
enable_fill_via_ajax(mixed $prefill, bool $default_style = false)

If fill via Ajax is enabled, the callback data is not included in the original template output put will be loaded using an ajax request right after the page has been loaded Use this feature to offload load intensive data queries

Parameters

mixed $prefill
bool $default_style

apply default style

at line 67
enable_periodical_update(mixed $interval)

Enable updating of container via AJAX all x seconds

Parameters

mixed $interval

Interval in seconds

at line 71
enable_use_back_history()

No description

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 120
get_content()

Returns the content of this container. Calls callback if neccessary

Returns a link which reloads the container

Parameters

$link_array

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

at line 91
process() deprecated

deprecated Use Container instead

No description

Exceptions

ContentException

at line 151
render()

Render Container with Content

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

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 38
set_content(mixed $content)

Set the content of the container to a static content (e.g. Template Object or HTML Output)

Parameters

mixed $content

Content Object (Template or HTML string)

at line 57
set_content_callback(mixed $callback, array|bool $parameters = false)

Set the content of the container by using a callback function

Parameters

mixed $callback

Content Object (Template or HTML string)

array|bool $parameters

Array of parameters

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 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 47
set_url(mixed $url)

set url to call - if not set, it will be set by get_current_url

Parameters

mixed $url