PHP Класс Phalcon\Paginator\Pager

Наследование: implements IteratorAggregate, implements Countable
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$limit integer | null Current rows limit (if provided)
$options array Array with options.
$paginateResult stdClass Phalcon's paginate result.

Открытые методы

Метод Описание
__construct ( Phalcon\Paginator\AdapterInterface $adapter, array $options = [] ) Class constructor.
count ( ) : integer
getCurrentPage ( ) : integer Returns the current page.
getFirstPage ( ) : integer Returns the first page.
getIterator ( ) : ArrayIterator
getLastPage ( ) : integer Returns the last page.
getLayout ( ) : Layout Returns the layout object.
getLimit ( ) : integer | null Get current rows limit (if provided)
getNextPage ( ) : integer Returns the next page.
getPagesInRange ( ) : array Returns array of page numbers that are in range of slider.
getPreviousPage ( ) : integer Returns the previous page.
haveToPaginate ( ) : boolean Return true if it's necessary to paginate or false if not.

Защищенные методы

Метод Описание
getRangeClass ( ) : string RangeClass option getter.
getRangeLength ( ) : integer RangeLength option getter.

Описание методов

__construct() публичный метод

Consumes Phalcon paginator adapter and options array. Option keys: - rangeClass: Class name which determines scrolling style type (e.g. Phalcon\Paginator\Pager\Range\Sliding). Defaults to "Phalcon\Paginator\Pager\Range\Sliding". - rangeLength: Size of range to be used. Default size is 10. - layoutClass: Used with getLayout() method. Defaults to "Phalcon\Paginator\Pager\Layout". - urlMask: Required with getLayout() method.
public __construct ( Phalcon\Paginator\AdapterInterface $adapter, array $options = [] )
$adapter Phalcon\Paginator\AdapterInterface Phalcon paginator adapter
$options array options array

count() публичный метод

public count ( ) : integer
Результат integer

getCurrentPage() публичный метод

Returns the current page.
public getCurrentPage ( ) : integer
Результат integer

getFirstPage() публичный метод

Returns the first page.
public getFirstPage ( ) : integer
Результат integer

getIterator() публичный метод

public getIterator ( ) : ArrayIterator
Результат ArrayIterator

getLastPage() публичный метод

Returns the last page.
public getLastPage ( ) : integer
Результат integer

getLayout() публичный метод

Returns the layout object.
public getLayout ( ) : Layout
Результат Phalcon\Paginator\Pager\Layout

getLimit() публичный метод

Get current rows limit (if provided)
public getLimit ( ) : integer | null
Результат integer | null

getNextPage() публичный метод

Returns the next page.
public getNextPage ( ) : integer
Результат integer

getPagesInRange() публичный метод

Returns array of page numbers that are in range of slider.
public getPagesInRange ( ) : array
Результат array array of page numbers

getPreviousPage() публичный метод

Returns the previous page.
public getPreviousPage ( ) : integer
Результат integer

getRangeClass() защищенный метод

RangeClass option getter.
protected getRangeClass ( ) : string
Результат string range class name

getRangeLength() защищенный метод

RangeLength option getter.
protected getRangeLength ( ) : integer
Результат integer range length

haveToPaginate() публичный метод

Return true if it's necessary to paginate or false if not.
public haveToPaginate ( ) : boolean
Результат boolean

Описание свойств

$limit защищенное свойство

Current rows limit (if provided)
protected int|null $limit
Результат integer | null

$options защищенное свойство

Array with options.
protected array $options
Результат array

$paginateResult защищенное свойство

Phalcon's paginate result.
protected stdClass $paginateResult
Результат stdClass