API Documentation
Back to top  

ExtendedInformationPager

Extends \Pager

ExtendedInformationPager

package

Default

Methods

Pager constructor.

__construct(\IntType $page, \IntType $perPage)
inherited

Arguments

$page

\IntType

Current page.

$perPage

\IntType

Items per page.

Named constructor of pager.

create(integer $page, integer $perPage) : \Pager
inherited static
Throws
\InvalidArgumentException

Arguments

$page

integer

Current page.

$perPage

integer

Items per page.

Response

\Pager

New instance.

Named constructor of pager.

createCustom( $offset,  $limit) : \Pager
inherited static
Throws
\InvalidArgumentException

Arguments

$offset

$limit

Response

\Pager

New instance.

Named constructor of extended information pager.

createExtendedInformationPager(integer $page, integer $perPage, integer $totalItemCount, string $pageParameter) : \ExtendedInformationPager
static
Throws
\InvalidArgumentException

Arguments

$page

integer

Current page.

$perPage

integer

Items per page.

$totalItemCount

integer

Total number of items.

$pageParameter

string

The name of the page parameter

Response

\ExtendedInformationPager

New instance.

Gets the highest item of the current page.

highestOnPage() : integer

Response

integer

Returns true if the current page is the first page.

isFirstPage() : boolean

Response

boolean

Returns true if the current page is the last page.

isLastPage() : boolean

Response

boolean

Gets the lowest item of the current page.

lowestOnPage() : integer

Response

integer

Returns the offset.

offset() : integer
inherited

Response

integer

Returns the current page.

page() : integer
inherited

Response

integer

Gets the name of the page parameter.

pageParameter() : string

Response

string

Returns the items count per page.

perPage() : integer
inherited

Response

integer

Gets the total number of items.

totalItemCount() : integer

Response

integer

Gets the total number of pages.

totalPageCount() : integer

Response

integer

Properties

totalItemCount

totalItemCount : integer
var

Type(s)

integer

pageParameter

pageParameter : string
var

Type(s)

string

page

page : integer
inherited
var

Type(s)

integer

perPage

perPage : integer
inherited
var

Type(s)

integer

offset

offset : integer
inherited
var

Type(s)

integer