Paginator
class Paginator
Paginating math.
Properties
int | $page | ||
int | $base | ||
int | $itemsPerPage | ||
int|null | $itemCount | ||
int read-only | $firstPage | ||
int|null read-only | $lastPage | ||
int read-only | $firstItemOnPage | ||
int read-only | $lastItemOnPage | ||
bool read-only | $first | ||
bool read-only | $last | ||
int|null read-only | $pageCount | ||
int read-only | $offset | ||
int|null read-only | $countdownOffset | ||
int read-only | $length |
Methods
Returns current page number.
Returns first page number.
Returns last page number.
Returns the sequence number of the first element on the page
Returns the sequence number of the last element on the page
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 49
Paginator
setPage(int $page)
Sets current page number.
at line 59
int
getPage()
Returns current page number.
at line 68
int
getFirstPage()
Returns first page number.
at line 77
int|null
getLastPage()
Returns last page number.
at line 88
int
getFirstItemOnPage()
Returns the sequence number of the first element on the page
at line 99
int
getLastItemOnPage()
Returns the sequence number of the last element on the page
at line 108
Paginator
setBase(int $base)
Sets first page (base) number.
at line 118
int
getBase()
Returns first page (base) number.
at line 127
protected int
getPageIndex()
Returns zero-based page number.
at line 139
bool
isFirst()
Is the current page the first one?
at line 148
bool
isLast()
Is the current page the last one?
at line 159
int|null
getPageCount()
Returns the total number of pages.
at line 170
Paginator
setItemsPerPage(int $itemsPerPage)
Sets the number of items to display on a single page.
at line 180
int
getItemsPerPage()
Returns the number of items to display on a single page.
at line 189
Paginator
setItemCount(int|null $itemCount = null)
Sets the total number of items.
at line 199
int|null
getItemCount()
Returns the total number of items.
at line 208
int
getOffset()
Returns the absolute index of the first item on current page.
at line 217
int|null
getCountdownOffset()
Returns the absolute index of the first item on current page in countdown paging.
at line 228
int
getLength()
Returns the number of items on current page.
Traits
Strict class for better experience.