Container
class Container extends UIAjaxComponent
Class Container
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 |
| XUILinkHelper | $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 | |
| protected string|callable | $content | ||
| protected string | $placeholderContent |
Methods
Adds a custom css class to the root element of this component.
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.
Adds a parameter to url parameter list.
Enables the periodical update via ajax.
Place
Returns a dependent object in order to interact with it
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
No description
Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI
No description
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.
Setting Placeholder Content will automatically enable deferred loading
Set Variable / Option for an array
No description
sets marker_content to passed data -> restore original content with reset_marker_content()
Sets options. This options will be used in the JS element of this XUI class.
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
Sets the url parameter that is used for component loading.
Details
in
UIComponent at line 64
__construct(string $link_id = null)
UIComponent constructor.
in
UIComponent at line 324
string
__toString()
No description
in
UIAjaxComponent at line 139
add_css_class($css_class)
Adds a custom css class to the root element of this component.
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.
in
UIAjaxComponent at line 80
add_url_parameter(mixed $key, mixed $value)
Adds a parameter to url parameter list.
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.
in
UIComponent at line 185
mixed
get($var)
Get Variable / Option
at line 54
protected string
getPlaceholderContent()
Place
in
UIAjaxComponent at line 122
mixed
get_dependency($dep_name)
Returns a dependent object in order to interact with it
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.
..
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
in
UIAjaxComponent at line 168
process()
dummy process method - may be overwritten
in
UIAjaxComponent at line 63
protected
process_xui()
Optional processing method.
This method is called when invoke the process method or automatically before the render method is called.
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
in
UIComponent at line 268
mixed
render_xtag_element()
No description
at line 30
string|Template
render_xui()
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
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.
at line 44
Container
setPlaceholderContent(string $placeholderContent)
Setting Placeholder Content will automatically enable deferred loading
in
UIComponent at line 122
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 23
set_content(string|callable $content)
No description
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
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.
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)
in
UIAjaxComponent at line 129
set_uid($uid)
No description
in
UIAjaxComponent at line 70
set_url_parameters(array $parameters)
Sets the url parameter that is used for component loading.