Paging
class Paging extends Container
Constants
| SYSTEM_TEMPLATE_UI_FOLDER |
|
| CONTAINER_LINK_MODE_REPLACE |
Link modes. Should the ajax respone replace the original content, or should it be appended/prepended |
| CONTAINER_LINK_MODE_APPEND |
|
| CONTAINER_LINK_MODE_PREPEND |
|
| RENDER_MODE_DEFAULT |
|
| RENDER_MODE_NUMBERS |
|
| RENDER_MODE_LOAD_MORE |
|
| RENDER_MODE_LOAD_PREVIOUS |
|
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 array | $xuiLinkedContainers | from UIAjaxComponent | |
| protected bool | $deferredLoading | from UIAjaxComponent | |
| protected bool | $deferredLoadingMessage | from UIAjaxComponent | |
| protected string|callable | $content | from Container | |
| protected string | $placeholderContent | from Container | |
| $numbers_before_and_after_dots |
Methods
No description
No description
Adds a custom css class to the root element of this component.
Add an UIAjaxComponent object and register it under a certain name.
Adds a parameter to url parameter list.
No description
Enables the periodical update via ajax.
Calculates and returns the current offset value usable by $modelCollection->limit()
No description
Returns a dependent object in order to interact with it
No description
No description
No description
No description
No description
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
Returns true, if the pagination is in load more / load previous mode.
No description
No description
No description
No description
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
No description
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
No description
Set the render mode to load more.
Set the render mode to load previous.
No description
No description
UIAjaxComponent where the pagination ajax request will refresh the contents.
Set Variable / Option for an array
No description
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.
No description
No description
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
No description
Sets the url parameter that is used for component loading.
Details
at line 127
__construct($record_count, $records_on_page, $paging_id = false, $record_start = false)
No description
in
UIComponent at line 328
string
__toString()
No description
at line 366
void
addLinkedContainer(UIAjaxComponent $linkedContainer, $linkMode = self::CONTAINER_LINK_MODE_REPLACE)
No description
in
UIAjaxComponent at line 196
add_css_class($css_class)
Adds a custom css class to the root element of this component.
in
UIAjaxComponent at line 134
add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)
Add an 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.
If reloadOnUpdate is set, the dependent container will be reloaded after the update of the current container. !Beware: The reload url of the dependency container will be the one set in its data attribute and not a possible "new url" used to update the current container. If you want to reload multiple containers at once when the current container is an ajax link target, use $this->addLinkedContainer()
in
UIAjaxComponent at line 94
add_url_parameter(mixed $key, mixed $value)
Adds a parameter to url parameter list.
at line 703
debug()
No description
in
UIAjaxComponent at line 218
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 187
mixed
get($var)
Get Variable / Option
in
UIAjaxComponent at line 456
false|mixed
getCurrentAjaxLink(array $params)
No description
at line 380
int
getCurrentOffset()
Calculates and returns the current offset value usable by $modelCollection->limit()
in
UIAjaxComponent at line 255
XUILinkHelper
getLinkHelper()
No description
at line 694
Paging
getLoadPrevious()
No description
in
Container at line 54
protected string
getPlaceholderContent()
Place
in
UIAjaxComponent at line 150
mixed
get_dependency($dep_name)
Returns a dependent object in order to interact with it
at line 250
int
get_first_record_of_page()
No description
at line 242
int
get_last_record_of_page()
No description
at line 270
int
get_number_of_current_page()
No description
at line 260
int
get_page_count()
No description
at line 234
int
get_records_per_page()
No description
in
UIComponent at line 204
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 294
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.
..
at line 341
bool
isInLoadMoreMode()
Returns true, if the pagination is in load more / load previous mode.
Only meaningful after $this->process() call.
at line 282
is_first_page()
No description
at line 286
is_last_page()
No description
in
UIComponent at line 223
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 239
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 265
mixed|string
parse_xtag($xml_source)
No description
at line 462
mixed
prepare_query(string $query)
No description
in
UIAjaxComponent at line 430
false|string
printAjaxLink(array $params)
No description
in
UIAjaxComponent at line 443
false|mixed
printCurrentAjaxLink(array $params)
No description
at line 156
process()
No description
in
UIAjaxComponent at line 76
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 281
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 273
mixed
render_xtag_element()
No description
at line 470
string|Template
render_xui()
No description
in
UIComponent at line 175
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 108
void
set(mixed $var, mixed $value = false)
deprecated
deprecated
Set Variable / Option
at line 88
Paging
setButtonLabelMore(string $buttonLabelMore)
No description
at line 98
Paging
setButtonLabelPrevious(string $buttonLabelPrevious)
No description
in
UIAjaxComponent at line 115
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.
in
UIAjaxComponent at line 102
UIAjaxComponent
setLoadURL(string $url)
No description
in
Container at line 44
Container
setPlaceholderContent(string $placeholderContent)
Setting Placeholder Content will automatically enable deferred loading
at line 328
void
setRenderModeDefault()
No description
at line 312
void
setRenderModeLoadMore(bool $mobileOnly = false)
Set the render mode to load more.
Requires a target XUI component via ->setTargetContainer()
at line 323
void
setRenderModeLoadPrevious(bool $mobileOnly = false)
Set the render mode to load previous.
Requires a target XUI component via ->setTargetContainer()
at line 332
void
setRenderModeNumbers()
No description
at line 108
Paging
setSmallButtonSize(bool $useSmallButton = true)
No description
at line 359
void
setTargetContainer(UIAjaxComponent $targetContainer)
UIAjaxComponent where the pagination ajax request will refresh the contents.
in
UIComponent at line 124
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
in
Container at line 23
set_content(string|callable $content)
No description
at line 278
set_default_page($page)
No description
at line 400
set_link_params($params)
No description
in
UIComponent at line 167
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 207
set_option(string $key, mixed $val)
Sets options. This options will be used in the JS element of this XUI class.
at line 140
set_params($record_count, $records_on_page, $paging_id = false, $record_start = false)
No description
at line 302
set_render_mode($mode)
No description
in
UIComponent at line 137
void
set_render_params(mixed $input_params = array())
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
at line 294
set_uid($uid)
No description
in
UIAjaxComponent at line 83
UIAjaxComponent
set_url_parameters(array $parameters)
Sets the url parameter that is used for component loading.