Class Paginator

Paginator class definition.

Direct known subclasses

Core\Modules\DB\Features\Paginator\Page

Namespace: Core\Modules\DB\Features\Paginator
Located at modules/db/features/paginator/paginator.php

Methods summary

`public`	# `__construct( integer $itemsCount, integer $itemsPerPage, integer $currentPage )` Init method. Init method. Parameters `$itemsCount` Items count number. `$itemsPerPage` Items count number per page. `$currentPage` Current page number.
`public integer`	# `totalPages( )` Total pages count getter. Total pages count getter. Returns integer
`public integer`	# `totalItems( )` Total retrieved items count getter. Total retrieved items count getter. Returns integer
`public integer`	# `itemsPerPage( )` Items per page counter getter. Items per page counter getter. Returns integer
`public boolean`	# `hasPage( mixed $page )` Checks if a pagination page exists. Checks if a pagination page exists. Parameters `$page` Pager number. Returns boolean
`public Core\Modules\DB\Features\Paginator\Page`	# `first( )` Paginates to the first pagination set. Paginates to the first pagination set. Returns `Core\Modules\DB\Features\Paginator\Page`
`public Core\Modules\DB\Features\Paginator\Page`	# `last( )` Paginates to the last pagination set. Paginates to the last pagination set. Returns `Core\Modules\DB\Features\Paginator\Page`
`public Core\Modules\DB\Features\Paginator\Page`	# `current( )` Paginates to the current pagination set. Paginates to the current pagination set. Returns `Core\Modules\DB\Features\Paginator\Page`
`public Core\Modules\DB\Features\Paginator\Page`	# `next( )` Paginates to the next pagination set. Paginates to the next pagination set. Returns `Core\Modules\DB\Features\Paginator\Page`
`public Core\Modules\DB\Features\Paginator\Page`	# `prev( )` Paginates to the previous pagination set. Paginates to the previous pagination set. Returns `Core\Modules\DB\Features\Paginator\Page`
`public boolean\|Core\Modules\DB\Features\Paginator\Page`	# `page( integer $page )` Paginates to the specified pagination number set. Paginates to the specified pagination number set. Parameters `$page` Page number. Returns boolean\|`Core\Modules\DB\Features\Paginator\Page`
`public array`	# `range( integer $padding = 1 )` Pagination range. Pagination range. Parameters `$padding` Padding count. Returns array
`public array`	# `pagesInRange( integer $padding = 2 )` Pages in range. Pages in range. Parameters `$padding` Padding count. Returns array
`public`	# `setCurrentPage( integer $page )` Sets current page. Sets current page. Parameters `$page` Page number.

Properties summary

`public integer`	`$pagesCount` Total pages count. Total pages count.	#
`protected Core\Modules\DB\Features\Paginator\Page`	`$currentPage` Current page. Current page.	#
`protected integer`	`$itemsPerPage` Items count per page. Items count per page.	#
`protected integer`	`$itemsTotalCount` Total items count. Total items count.	#