PHP Класс Adldap\Objects\Paginator

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

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

Свойство Тип Описание
$currentOffset integer The current entry offset number.
$currentPage integer The current page number.
$pages integer The total amount of pages.
$perPage integer The amount of entries per page.
$results array The complete results array.

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

Метод Описание
__construct ( array $results = [], integer $perPage = 50, integer $currentPage, integer $pages ) Constructor.
count ( ) : integer Returns the total amount of results.
getCurrentOffset ( ) : integer Returns the current offset number.
getCurrentPage ( ) : integer Returns the current page number.
getIterator ( ) : ArrayIterator Get an iterator for the entries.
getPages ( ) : integer Returns the total amount of pages in a paginated result.
getPerPage ( ) : integer Returns the total amount of entries allowed per page.
getResults ( ) : array Returns the complete results array.

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

Метод Описание
setCurrentOffset ( integer $offset ) : Paginator Sets the current offset number.
setCurrentPage ( integer $currentPage ) : Paginator Sets the current page number.
setPages ( integer $pages ) : Paginator Sets the total number of pages.
setPerPage ( integer $perPage = 50 ) : Paginator Sets the number of entries per page.
setResults ( array $results ) : Paginator Sets the results array property.

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

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

Constructor.
public __construct ( array $results = [], integer $perPage = 50, integer $currentPage, integer $pages )
$results array
$perPage integer
$currentPage integer
$pages integer

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

Returns the total amount of results.
public count ( ) : integer
Результат integer

getCurrentOffset() публичный Метод

Returns the current offset number.
public getCurrentOffset ( ) : integer
Результат integer

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

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

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

Get an iterator for the entries.
public getIterator ( ) : ArrayIterator
Результат ArrayIterator

getPages() публичный Метод

Returns the total amount of pages in a paginated result.
public getPages ( ) : integer
Результат integer

getPerPage() публичный Метод

Returns the total amount of entries allowed per page.
public getPerPage ( ) : integer
Результат integer

getResults() публичный Метод

Returns the complete results array.
public getResults ( ) : array
Результат array

setCurrentOffset() защищенный Метод

Sets the current offset number.
protected setCurrentOffset ( integer $offset ) : Paginator
$offset integer
Результат Paginator

setCurrentPage() защищенный Метод

Sets the current page number.
protected setCurrentPage ( integer $currentPage ) : Paginator
$currentPage integer
Результат Paginator

setPages() защищенный Метод

Sets the total number of pages.
protected setPages ( integer $pages ) : Paginator
$pages integer
Результат Paginator

setPerPage() защищенный Метод

Sets the number of entries per page.
protected setPerPage ( integer $perPage = 50 ) : Paginator
$perPage integer
Результат Paginator

setResults() защищенный Метод

Sets the results array property.
protected setResults ( array $results ) : Paginator
$results array
Результат Paginator

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

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

The current entry offset number.
protected int $currentOffset
Результат integer

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

The current page number.
protected int $currentPage
Результат integer

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

The total amount of pages.
protected int $pages
Результат integer

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

The amount of entries per page.
protected int $perPage
Результат integer

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

The complete results array.
protected array $results
Результат array