PHP 클래스 seregazhuk\PinterestBot\Helpers\Pagination

상속: implements IteratorAggregate
파일 보기 프로젝트 열기: seregazhuk/php-pinterest-bot 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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