Orpheus

Paginator
in package
implements IteratorAggregate

Class Paginator

Tool to paginate result from query through multiple pages

TODO This tool is outdated, it was not recently tested

Table of Contents

Interfaces

IteratorAggregate

Properties

$displayEmpty  : bool
$layout  : string
$page  : int
$pageDelta  : int
$query  : SqlSelectRequest
$rendered  : string|null
$rowCount  : int
$rowPerPage  : int
$url  : string

Methods

__construct()  : mixed
__toString()  : string
getDisplayEmpty()  : bool
getIterator()  : Traversable
getLastPage()  : int
getLayout()  : string
getMajorPage()  : int
getMinorPage()  : int
getPage()  : int
getPageDelta()  : int
getPageLink()  : string
getQuery()  : SqlSelectRequest
getRendered()  : string
getRowCount()  : int
getRowPerPage()  : int
getUrl()  : string
next()  : mixed
render()  : string|null
setDisplayEmpty()  : static
setLayout()  : static
setPage()  : static
setPageDelta()  : static
setQuery()  : static
setRowPerPage()  : static
setUrl()  : static
verify()  : HttpResponse|null
calculate()  : void

Properties

$displayEmpty

protected bool $displayEmpty = false

$rendered

protected string|null $rendered = null

Methods

__construct()

public __construct(string $route, SqlSelectRequest $query[, int $page = 1 ][, int $rowPerPage = 100 ]) : mixed
Parameters
$route : string
$query : SqlSelectRequest
$page : int = 1
$rowPerPage : int = 100

__toString()

public __toString() : string
Return values
string

getDisplayEmpty()

public getDisplayEmpty() : bool
Return values
bool

getIterator()

public getIterator() : Traversable
Return values
Traversable

getLastPage()

public getLastPage() : int
Return values
int

getLayout()

public getLayout() : string
Return values
string

getMajorPage()

public getMajorPage() : int
Return values
int

getMinorPage()

public getMinorPage() : int
Return values
int

getPage()

public getPage() : int
Return values
int

getPageDelta()

public getPageDelta() : int
Return values
int

getPageLink()

public getPageLink(mixed $page) : string
Parameters
$page : mixed
Return values
string

getRendered()

public getRendered() : string
Return values
string

getRowCount()

public getRowCount() : int
Return values
int

getRowPerPage()

public getRowPerPage() : int
Return values
int

getUrl()

public getUrl() : string
Return values
string

render()

public render() : string|null
Return values
string|null

setDisplayEmpty()

public setDisplayEmpty(bool $displayEmpty) : static
Parameters
$displayEmpty : bool
Return values
static

setLayout()

public setLayout(string $layout) : static
Parameters
$layout : string
Return values
static

setPage()

public setPage(int $page) : static
Parameters
$page : int
Return values
static

setPageDelta()

public setPageDelta(int $pageDelta) : static
Parameters
$pageDelta : int
Return values
static

setRowPerPage()

public setRowPerPage(int $rowPerPage) : static
Parameters
$rowPerPage : int
Return values
static

setUrl()

public setUrl(string $url) : static
Parameters
$url : string
Return values
static 

							

							
						

					

					
					
				
				

			

			

				
				

					On this page
					
					
				

			
			

		

		

			

				

					
Search results