1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. Paging

Paging

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
string read-only $_content

When used in template this property will contain the XML/HTML within the XUI Nodes

 from  UIComponent
$numbers_before_and_after_dots

Methods

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

No description

string
__toString()

No description

from  UIComponent
debug()

No description

mixed
get($var)

Get Variable / Option

from  UIComponent
int
get_first_record_of_page()

No description

int
get_last_record_of_page()

No description

int
get_number_of_current_page()

No description

int
get_page_count()

No description

int
get_records_per_page()

No description

string
get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

from  UIComponent
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

from  UIComponent
init()

put your comment there.

is_first_page()

No description

is_last_page()

No description

string
parse_template(string $template_content, array|bool $marker_array = false)

No description

from  UIComponent
string|null
parse_template_cb_wrapper(mixed $matches)

No description

from  UIComponent
mixed|string
parse_xtag($xml_source)

No description

from  UIComponent
mixed
prepare_query(string $query)

No description

process()

No description

render()

No description

mixed
render_xtag_element()

No description

from  UIComponent
void
reset_marker_content()

restores original content of marker_content

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

Set Variable / Option

from  UIComponent
void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_default_page($page)

No description

set_link_params($params)

No description

void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

from  UIComponent
set_mod(mixed $mod)

Set link to owning module

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

No description

set_render_mode($mode)

No description

void
set_render_params(mixed $input_params = array())

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

from  UIComponent
set_uid($uid)

No description

Details

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

No description

Parameters

$record_count
$records_on_page
$paging_id
$record_start

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 395
debug()

No description

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 180
int get_first_record_of_page()

No description

Return Value

int

first record displayed

at line 172
int get_last_record_of_page()

No description

Return Value

int

last record displayed

at line 200
int get_number_of_current_page()

No description

Return Value

int

current page

at line 190
int get_page_count()

No description

Return Value

int

total count of pages

at line 164
int get_records_per_page()

No description

Return Value

int

numer of records on a page

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

at line 90
init()

put your comment there.

..

at line 212
is_first_page()

No description

at line 216
is_last_page()

No description

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 271
mixed prepare_query(string $query)

No description

Parameters

string $query

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

Return Value

mixed

at line 97
process()

No description

at line 279
render()

No description

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 208
set_default_page($page)

No description

Parameters

$page

No description

Parameters

$params

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

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

No description

Parameters

$record_count
$records_on_page
$paging_id
$record_start

at line 232
set_render_mode($mode)

No description

Parameters

$mode

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 224
set_uid($uid)

No description

Parameters

$uid