1. class
  2. Nette
  3. \
  4. Utils
  5. \
  6. Paginator

Paginator

class Paginator

Paginating math.

Properties

int $page
int $base
positive-int $itemsPerPage
int<0, max>|null $itemCount
int read-only $firstPage
int|null read-only $lastPage
int<0, max> read-only $firstItemOnPage
int<0, max> read-only $lastItemOnPage
bool read-only $first
bool read-only $last
int<0, max>|null read-only $pageCount
int<0, max> read-only $offset
int<0, max>|null read-only $countdownOffset
int<0, max> read-only $length

Methods

Paginator
setPage(int $page)

Sets current page number.

int
getPage()

Returns current page number.

int
getFirstPage()

Returns first page number.

int|null
getLastPage()

Returns last page number.

int
getFirstItemOnPage()

Returns the sequence number of the first element on the page

int
getLastItemOnPage()

Returns the sequence number of the last element on the page

Paginator
setBase(int $base)

Sets first page (base) number.

int
getBase()

Returns first page (base) number.

int
getPageIndex()

Returns zero-based page number.

bool
isFirst()

Is the current page the first one?

bool
isLast()

Is the current page the last one?

int|null
getPageCount()

Returns the total number of pages.

Paginator
setItemsPerPage(int $itemsPerPage)

Sets the number of items to display on a single page.

int
getItemsPerPage()

Returns the number of items to display on a single page.

Paginator
setItemCount(int|null $itemCount = null)

Sets the total number of items.

int|null
getItemCount()

Returns the total number of items.

int
getOffset()

Returns the absolute index of the first item on current page.

int|null
getCountdownOffset()

Returns the absolute index of the first item on current page in countdown paging.

int
getLength()

Returns the number of items on current page.

Details

at line 54
Paginator setPage(int $page)

Sets current page number.

Parameters

int $page

Return Value

Paginator

at line 64
int getPage()

Returns current page number.

Return Value

int

at line 73
int getFirstPage()

Returns first page number.

Return Value

int

at line 82
int|null getLastPage()

Returns last page number.

Return Value

int|null

at line 94
int getFirstItemOnPage()

Returns the sequence number of the first element on the page

Return Value

int

at line 106
int getLastItemOnPage()

Returns the sequence number of the last element on the page

Return Value

int

at line 116
Paginator setBase(int $base)

Sets first page (base) number.

Parameters

int $base

Return Value

Paginator

at line 126
int getBase()

Returns first page (base) number.

Return Value

int

at line 136
protected int getPageIndex()

Returns zero-based page number.

Return Value

int

at line 148
bool isFirst()

Is the current page the first one?

Return Value

bool

at line 157
bool isLast()

Is the current page the last one?

Return Value

bool

at line 169
int|null getPageCount()

Returns the total number of pages.

Return Value

int|null

at line 181
Paginator setItemsPerPage(int $itemsPerPage)

Sets the number of items to display on a single page.

Parameters

int $itemsPerPage

Return Value

Paginator

at line 192
int getItemsPerPage()

Returns the number of items to display on a single page.

Return Value

int

at line 202
Paginator setItemCount(int|null $itemCount = null)

Sets the total number of items.

Parameters

int|null $itemCount

Return Value

Paginator

at line 213
int|null getItemCount()

Returns the total number of items.

Return Value

int|null

at line 223
int getOffset()

Returns the absolute index of the first item on current page.

Return Value

int

at line 233
int|null getCountdownOffset()

Returns the absolute index of the first item on current page in countdown paging.

Return Value

int|null

at line 245
int getLength()

Returns the number of items on current page.

Return Value

int

Traits

SmartObject

Strict class for better experience.