PHP Class seregazhuk\PinterestBot\Helpers\Pagination

Inheritance: implements IteratorAggregate
Afficher le fichier Open project: seregazhuk/php-pinterest-bot Class Usage Examples

Protected Properties

Свойство Type Description
$bookmarks array
$callback callable
$limit integer
$offset integer

Méthodes publiques

Méthode 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

Méthodes protégées

Méthode 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.

Method Details

__construct() public méthode

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

checkEndBookMarks() protected méthode

Checks for -end- substring in bookmarks. This is pinterest sign of the finished pagination.
protected checkEndBookMarks ( ) : boolean
Résultat boolean

get() public méthode

Syntax sugar for getIterator method
public get ( ) : Traversable
Résultat Traversable

getCurrentResults() protected méthode

protected getCurrentResults ( ) : array
Résultat array

getIterator() public méthode

Retrieve an external iterator
public getIterator ( ) : Traversable
Résultat Traversable

paginateOver() public méthode

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 méthode

protected paginationFinished ( integer $resultsNum ) : boolean
$resultsNum integer
Résultat boolean

processResponse() protected méthode

protected processResponse ( seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse $response ) : array
$response seregazhuk\PinterestBot\Api\Contracts\PaginatedResponse
Résultat array

reachesLimit() protected méthode

Check if we get results limit in pagination.
protected reachesLimit ( integer $resultsNum ) : boolean
$resultsNum integer
Résultat boolean

skip() public méthode

public skip ( integer $offset )
$offset integer

take() public méthode

public take ( integer $limit )
$limit integer

toArray() public méthode

public toArray ( ) : array
Résultat array

Property Details

$bookmarks protected_oe property

protected array $bookmarks
Résultat array

$callback protected_oe property

protected callable $callback
Résultat callable

$limit protected_oe property

protected int $limit
Résultat integer

$offset protected_oe property

protected int $offset
Résultat integer