Paginator
class Paginator extends Object
Paginating math.
Properties
| int | $page | ||
| int | $base | ||
| int | $itemsPerPage | ||
| int|null | $itemCount | ||
| int read-only | $firstPage | ||
| int|null read-only | $lastPage | ||
| bool read-only | $first | ||
| bool read-only | $last | ||
| int|null read-only | $pageCount | ||
| int read-only | $offset | ||
| int|null read-only | $countdownOffset | ||
| int|null read-only | $length |
Methods
Returns current page number.
Returns first page number.
Returns last page number.
Returns first page (base) number.
Returns zero-based page number.
Is the current page the first one?
Is the current page the last one?
Returns the total number of pages.
Sets the number of items to display on a single page.
Returns the number of items to display on a single page.
Sets the total number of items.
Returns the total number of items.
Returns the absolute index of the first item on current page.
Returns the absolute index of the first item on current page in countdown paging.
Returns the number of items on current page.
Details
at line 51
Paginator
setPage($page)
Sets current page number.
at line 62
int
getPage()
Returns current page number.
at line 72
int
getFirstPage()
Returns first page number.
at line 82
int|null
getLastPage()
Returns last page number.
at line 93
Paginator
setBase($base)
Sets first page (base) number.
at line 104
int
getBase()
Returns first page (base) number.
at line 114
protected int
getPageIndex()
Returns zero-based page number.
at line 125
bool
isFirst()
Is the current page the first one?
at line 135
bool
isLast()
Is the current page the last one?
at line 145
int|null
getPageCount()
Returns the total number of pages.
at line 156
Paginator
setItemsPerPage($itemsPerPage)
Sets the number of items to display on a single page.
at line 167
int
getItemsPerPage()
Returns the number of items to display on a single page.
at line 178
Paginator
setItemCount($itemCount)
Sets the total number of items.
at line 189
int|null
getItemCount()
Returns the total number of items.
at line 199
int
getOffset()
Returns the absolute index of the first item on current page.
at line 209
int|null
getCountdownOffset()
Returns the absolute index of the first item on current page in countdown paging.
at line 221
int|null
getLength()
Returns the number of items on current page.