PaginationInterface
extends
Countable, IteratorAggregate
in
Interface PaginationInterface
Tags
Table of Contents
Methods
- count() : int
- getFirstPage() : PaginationPage|null
- getLastPage() : PaginationPage|null
- getLimit() : int
- getNextNumber() : int|null
- getNextPage() : PaginationPage|null
- getOptions() : array<string|int, mixed>
- getPage() : PaginationPage|null
- getPageNumber() : int
- getPrevNumber() : int|null
- getPrevPage() : PaginationPage|null
- getStart() : int
- getTotal() : int
- getTotalPages() : int
Methods
count()
public
count() : int
Return values
intgetFirstPage()
public
getFirstPage([string|null $label = null ][, int $count = 0 ]) : PaginationPage|null
Parameters
- $label : string|null = null
- $count : int = 0
Return values
PaginationPage|nullgetLastPage()
public
getLastPage([string|null $label = null ][, int $count = 0 ]) : PaginationPage|null
Parameters
- $label : string|null = null
- $count : int = 0
Return values
PaginationPage|nullgetLimit()
public
getLimit() : int
Return values
intgetNextNumber()
public
getNextNumber([int $count = 1 ]) : int|null
Parameters
- $count : int = 1
Return values
int|nullgetNextPage()
public
getNextPage([string|null $label = null ][, int $count = 1 ]) : PaginationPage|null
Parameters
- $label : string|null = null
- $count : int = 1
Return values
PaginationPage|nullgetOptions()
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getPage()
public
getPage(int $page[, string|null $label = null ]) : PaginationPage|null
Parameters
- $page : int
- $label : string|null = null
Return values
PaginationPage|nullgetPageNumber()
public
getPageNumber() : int
Return values
intgetPrevNumber()
public
getPrevNumber([int $count = 1 ]) : int|null
Parameters
- $count : int = 1
Return values
int|nullgetPrevPage()
public
getPrevPage([string|null $label = null ][, int $count = 1 ]) : PaginationPage|null
Parameters
- $label : string|null = null
- $count : int = 1
Return values
PaginationPage|nullgetStart()
public
getStart() : int
Return values
intgetTotal()
public
getTotal() : int
Return values
intgetTotalPages()
public
getTotalPages() : int