PHP Class Paginator_Basic, atk4

It will render itself into parent and will limit the source to display limited number of records per page with ability to travel back and forth.

Inheritance: extends CompleteLister

Datei anzeigen Open project: atk4/atk4

Public Properties

Property	Type	Description
$ajax_reload	boolean	Should we reload parent with AJAX ?
$base_page	string	lSet this to nicely redefine base page
$cur_page	integer
$found_rows	integer
$ipp	integer	How many records should we show per page.
$memorize	boolean	Should we remember page when user comes back ?
$owner	View
$range	integer	How many adjacent pages from current page should we show.
$skip	integer	How many records should we skip. By default don't skip anything.
$skip_var	string	GET argument to use to specify page
$source	SQL_Model \| Model \| DB_dsql \| mixed	Data source. Set with setSource().
$total_pages	integer

Public Methods

Method	Description
defaultSpot ( ) : string	Set default spot.
defaultTemplate ( ) : array \| string	Set default template.
init ( )	Initialization.
ipp ( $rows )
recursiveRender ( )	Recursively render this view.
setRowsPerPage ( integer $rows )	Set number of items displayed per page.
setSource ( SQL_Model \| Model \| DB_dsql \| mixed $source )	Set a custom source. Must be an object with foundRows() method.

Method Details

defaultSpot() public method

Set default spot.

public defaultSpot ( ) : string
return	string

defaultTemplate() public method

Set default template.

public defaultTemplate ( ) : array \| string
return	array \| string

init() public method

Initialization.

public init ( )

ipp() public method

Deprecation: 4.3.2 use setRowsPerPage instead.

public ipp ( $rows )

recursiveRender() public method

Recursively render this view.

public recursiveRender ( )

setRowsPerPage() public method

Set number of items displayed per page.

public setRowsPerPage ( integer $rows )
$rows	integer

setSource() public method

Set a custom source. Must be an object with foundRows() method.

public setSource ( SQL_Model \| Model \| DB_dsql \| mixed $source )
$source	SQL_Model \| Model \| DB_dsql \| mixed

Property Details

$ajax_reload public_oe property

Should we reload parent with AJAX ?

public bool $ajax_reload
return	boolean

$base_page public_oe property

lSet this to nicely redefine base page

public string $base_page
return	string

$cur_page public_oe property

public int $cur_page
return	integer

$found_rows public_oe property

public int $found_rows
return	integer

$ipp public_oe property

How many records should we show per page.

public int $ipp
return	integer

$memorize public_oe property

Should we remember page when user comes back ?

public bool $memorize
return	boolean

$owner public_oe property

public View $owner
return	View

$range public_oe property

How many adjacent pages from current page should we show.

public int $range
return	integer

$skip public_oe property

How many records should we skip. By default don't skip anything.

public int $skip
return	integer

$skip_var public_oe property

GET argument to use to specify page

public string $skip_var
return	string

$source public_oe property

Data source. Set with setSource().

public SQL_Model\|Model\|DB_dsql\|mixed $source
return	SQL_Model \| Model \| DB_dsql \| mixed

$total_pages public_oe property

public int $total_pages
return	integer