PaginatorInterface
in
Paginator interface
Tags
Table of Contents
Methods
- calculateRange() : array<string|int, mixed>
- Calculate the page range
- getBookend() : string|null
- Get a bookend
- getBookends() : array<string|int, mixed>
- Get the bookends
- getCurrentPage() : int
- Get the current page
- getNumberOfPages() : int
- Get the number of pages
- getPerPage() : int
- Get the per page
- getQueryKey() : string
- Get the query key
- getRange() : int
- Get the page range
- getTotal() : int
- Get the content items total
- setBookends() : PaginatorInterface
- Set the bookends
- setQueryKey() : PaginatorInterface
- Set the query key
Methods
calculateRange()
Calculate the page range
public
calculateRange([int $page = 1 ]) : array<string|int, mixed>
Parameters
- $page : int = 1
Return values
array<string|int, mixed>getBookend()
Get a bookend
public
getBookend(string $key) : string|null
Parameters
- $key : string
Return values
string|nullgetBookends()
Get the bookends
public
getBookends() : array<string|int, mixed>
Return values
array<string|int, mixed>getCurrentPage()
Get the current page
public
getCurrentPage() : int
Return values
intgetNumberOfPages()
Get the number of pages
public
getNumberOfPages() : int
Return values
intgetPerPage()
Get the per page
public
getPerPage() : int
Return values
intgetQueryKey()
Get the query key
public
getQueryKey() : string
Return values
stringgetRange()
Get the page range
public
getRange() : int
Return values
intgetTotal()
Get the content items total
public
getTotal() : int
Return values
intsetBookends()
Set the bookends
public
setBookends(array<string|int, mixed> $bookends) : PaginatorInterface
Parameters
- $bookends : array<string|int, mixed>
Return values
PaginatorInterfacesetQueryKey()
Set the query key
public
setQueryKey(string $key) : PaginatorInterface
Parameters
- $key : string