PHP Класс seregazhuk\PinterestBot\Helpers\Pagination

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

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

Свойство Тип Описание
$bookmarks array
$callback callable
$limit integer
$offset integer

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

Метод Описание
__construct ( integer $limit = self::DEFAULT_LIMIT )
get ( ) : Traversable Syntax sugar for getIterator method
getIterator ( ) : Traversable Retrieve an external iterator
paginateOver ( callable $callback ) Sets a callback to make requests. Should be a closure that accepts a $bookmarks array as an argument.
skip ( integer $offset )
take ( integer $limit )
toArray ( ) : array

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

Метод Описание
checkEndBookMarks ( ) : boolean Checks for -end- substring in bookmarks. This is pinterest sign of the finished pagination.
getCurrentResults ( ) : array
paginationFinished ( integer $resultsNum ) : boolean
processResponse ( seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse $response ) : array
reachesLimit ( integer $resultsNum ) : boolean Check if we get results limit in pagination.

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

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

public __construct ( integer $limit = self::DEFAULT_LIMIT )
$limit integer

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

Checks for -end- substring in bookmarks. This is pinterest sign of the finished pagination.
protected checkEndBookMarks ( ) : boolean
Результат boolean

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

Syntax sugar for getIterator method
public get ( ) : Traversable
Результат Traversable

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

protected getCurrentResults ( ) : array
Результат array

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

Retrieve an external iterator
public getIterator ( ) : Traversable
Результат Traversable

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

Sets a callback to make requests. Should be a closure that accepts a $bookmarks array as an argument.
public paginateOver ( callable $callback )
$callback callable

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

protected paginationFinished ( integer $resultsNum ) : boolean
$resultsNum integer
Результат boolean

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

protected processResponse ( seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse $response ) : array
$response seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse
Результат array

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

Check if we get results limit in pagination.
protected reachesLimit ( integer $resultsNum ) : boolean
$resultsNum integer
Результат boolean

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

public skip ( integer $offset )
$offset integer

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

public take ( integer $limit )
$limit integer

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

public toArray ( ) : array
Результат array

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

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

protected array $bookmarks
Результат array

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

protected callable $callback
Результат callable

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

protected int $limit
Результат integer

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

protected int $offset
Результат integer