PHP Class seregazhuk\PinterestBot\Helpers\Pagination

Inheritance: implements IteratorAggregate

Protected Properties

Method	Description
__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

Method	Description
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.

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

Checks for -end- substring in bookmarks. This is pinterest sign of the finished pagination.

protected checkEndBookMarks ( ) : boolean
return	boolean

Syntax sugar for getIterator method

public get ( ) : Traversable
return	Traversable

protected getCurrentResults ( ) : array
return	array

Retrieve an external iterator

public getIterator ( ) : Traversable
return	Traversable

Sets a callback to make requests. Should be a closure that accepts a $bookmarks array as an argument.

public paginateOver ( callable $callback )
$callback	callable

protected paginationFinished ( integer $resultsNum ) : boolean
$resultsNum	integer
return	boolean

protected processResponse ( seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse $response ) : array
$response	seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse
return	array

Check if we get results limit in pagination.

protected reachesLimit ( integer $resultsNum ) : boolean
$resultsNum	integer
return	boolean

public skip ( integer $offset )
$offset	integer

public take ( integer $limit )
$limit	integer

public toArray ( ) : array
return	array

protected array $bookmarks
return	array

protected callable $callback
return	callable

protected int $limit
return	integer

protected int $offset
return	integer