class Paging extends UIComponent

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
$numbers_before_and_after_dots

Methods

__construct($record_count, $records_on_page, $paging_id = false, $record_start = false)

No description

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

No description

render()

No description

set_params($record_count, $records_on_page, $paging_id = false, $record_start = false)

No description

get_records_per_page()

No description

int
get_last_record_of_page()

No description

int
get_first_record_of_page()

No description

int
get_page_count()

No description

int
get_number_of_current_page()

No description

set_default_page($page)

No description

is_first_page()

No description

is_last_page()

No description

set_uid($uid)

No description

set_render_mode($mode)

No description

set_link_params($params)

No description

mixed
prepare_query(string $query)

No description

debug()

No description

Details

at line 67
__construct($record_count, $records_on_page, $paging_id = false, $record_start = false)

Parameters

$record_count
$records_on_page
$paging_id
$record_start

at line 90
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

at line 97
process()

at line 279
render()

at line 78
set_params($record_count, $records_on_page, $paging_id = false, $record_start = false)

Parameters

$record_count
$records_on_page
$paging_id
$record_start

at line 164
get_records_per_page()

at line 172
int get_last_record_of_page()

Return Value

int last record displayed

at line 180
int get_first_record_of_page()

Return Value

int first record displayed

at line 190
int get_page_count()

Return Value

int total count of pages

at line 200
int get_number_of_current_page()

Return Value

int current page

at line 208
set_default_page($page)

Parameters

$page

at line 212
is_first_page()

at line 216
is_last_page()

at line 224
set_uid($uid)

Parameters

$uid

at line 232
set_render_mode($mode)

Parameters

$mode

Parameters

$params

at line 271
mixed prepare_query(string $query)

Parameters

string $query SQL Query to parse, e.g. SELECT * FROM ###tbl|user### ###limit###

Return Value

mixed

at line 395
debug()