Docs For Class miTablePager

Description

Recordset Pager Class Manage the movement between pages when data is shown in table fomat

copyright: Copyright (c) 2003-2006 Mirchev Ideas Ltd. All rights reserved.

Located in /view/TablePager.php (line 16)

miTableFeature
   |
   --miTablePager

Direct descendents

Class	Description
miDefaultTablePager	Default Recordset Pager Class Manage the movement between pages when data is shown in table fomat
miSimpleTablePager	Default Recordset Pager Class Manage the movement between pages when data is shown in table fomat

Class Constant Summary

PARAM_PAGE = 'page'

PARAM_RECORDS_PER_PAGE = 'recordsPerPage'

TMPL_VAR_FIRST_RECORD = 'FIRST_RECORD'

TMPL_VAR_LAST_RECORD = 'LAST_RECORD'

TMPL_VAR_RECORDSET_NAVIGATOR = 'HTML_RECORDSET_NAVIGATOR'

TMPL_VAR_RECORDSET_POSITION = 'RECORDSET_POSITION'

TMPL_VAR_TOTAL_RECORDS = 'TOTAL_RECORDS'

Variable Summary

mixed $_defaultRecordsPerPage

mixed $_page

mixed $_recordsPerPage

mixed $_totalRecords

Method Summary

miTablePager __construct ( $table)

array assignPosition ()

void getNavigatorParams ()

string getPageParam ()

string getRecordsPerPageParam ()

array getStateParams ()

array getValues ()

void setDefaultRecordsPerPage (int $defaultRecordsPerPage)

void setPagerLocation ($page $page, $recordsPerPage $recordsPerPage, $totalRecords $totalRecords)

Variables

mixed $_defaultRecordsPerPage (line 53)

The records per page by default

access: protected

mixed $_page = 0 (line 32)

The current page number

access: protected

mixed $_recordsPerPage (line 39)

Number of records per page

access: protected

mixed $_totalRecords = 0 (line 46)

Total number of records

access: protected

Inherited Variables

Inherited from miTableFeature

miTableFeature::$_table

Methods

Constructor __construct (line 58)

miTablePager __construct ( $table)

$table

Redefinition of:

miTableFeature::__construct(): Constructs a table feature

assignPosition (line 144)

Calculates first and last positions for a page from the total recodrs

access: protected

array assignPosition ()

getNavigatorParams (line 169)

Gets navigator links params

access: protected

void getNavigatorParams ()

getPageParam (line 122)

Gets the value of "page" param

access: public

string getPageParam ()

getRecordsPerPageParam (line 133)

Gets the value of "records per page" param

access: public

string getRecordsPerPageParam ()

getStateParams (line 96)

Returns associative array with params that save the feature state

access: public

array getStateParams ()

Redefinition of:

miTableFeature::getStateParams(): Returns associative array with params that save the feature state

getValues (line 86)

In this function subclasses will return Navigator

access: public

array getValues ()

Redefinition of:

miTableFeature::getValues(): Get the feature values

Redefined in descendants as:

miDefaultTablePager::getValues() : Return Default Navigator
miSimpleTablePager::getValues() : Return Simple Navigator

setDefaultRecordsPerPage (line 111)

Sets the default records per page

access: public

void setDefaultRecordsPerPage (int $defaultRecordsPerPage)

int $defaultRecordsPerPage: the number of records per page by default

setPagerLocation (line 73)

Sets the pager location

access: public

void setPagerLocation ($page $page, $recordsPerPage $recordsPerPage, $totalRecords $totalRecords)

$page $page: integer
$recordsPerPage $recordsPerPage: integer
$totalRecords $totalRecords: integer

Inherited Methods

Inherited From miTableFeature

miTableFeature::__construct()
miTableFeature::getStateParams()
miTableFeature::getStateValue()
miTableFeature::getValues()

Class Constants

PARAM_PAGE = 'page' (line 24)

PARAM_RECORDS_PER_PAGE = 'recordsPerPage' (line 25)

TMPL_VAR_FIRST_RECORD = 'FIRST_RECORD' (line 20)

TMPL_VAR_LAST_RECORD = 'LAST_RECORD' (line 21)

TMPL_VAR_RECORDSET_NAVIGATOR = 'HTML_RECORDSET_NAVIGATOR' (line 18)

TMPL_VAR_RECORDSET_POSITION = 'RECORDSET_POSITION' (line 19)

TMPL_VAR_TOTAL_RECORDS = 'TOTAL_RECORDS' (line 22)