Class Github\ResultPager

InheritanceGithub\ResultPager
ImplementsGithub\ResultPagerInterface

Pager class for supporting pagination in github classes.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() The Github client to use for pagination. Github\ResultPager
fetch() {@inheritdoc} Github\ResultPager
fetchAll() {@inheritdoc} Github\ResultPager
fetchFirst() {@inheritdoc} Github\ResultPager
fetchLast() {@inheritdoc} Github\ResultPager
fetchNext() {@inheritdoc} Github\ResultPager
fetchPrevious() {@inheritdoc} Github\ResultPager
getPagination() {@inheritdoc} Github\ResultPager
hasNext() {@inheritdoc} Github\ResultPager
hasPrevious() {@inheritdoc} Github\ResultPager
postFetch() {@inheritdoc} Github\ResultPager

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
get() {@inheritdoc} Github\ResultPager
has() {@inheritdoc} Github\ResultPager

Property Details

$client protected property
protected Github\Client $client null
$pagination protected property
protected array $pagination null

Method Details

__construct() public method

The Github client to use for pagination.

This must be the same instance that you got the Api instance from.

Example code:

$client = new \Github\Client(); $api = $client->api('someApi'); $pager = new \Github\ResultPager($client);

public void __construct ( Github\Client $client )
$client Github\Client
fetch() public method

{@inheritdoc}

public void fetch ( Github\Api\ApiInterface $api, $method, array $parameters = [] )
$api
$method
$parameters
fetchAll() public method

{@inheritdoc}

public void fetchAll ( Github\Api\ApiInterface $api, $method, array $parameters = [] )
$api
$method
$parameters
fetchFirst() public method

{@inheritdoc}

public void fetchFirst ( )
fetchLast() public method

{@inheritdoc}

public void fetchLast ( )
fetchNext() public method

{@inheritdoc}

public void fetchNext ( )
fetchPrevious() public method

{@inheritdoc}

public void fetchPrevious ( )
get() protected method

{@inheritdoc}

protected void get ( $key )
$key
getPagination() public method

{@inheritdoc}

public void getPagination ( )
has() protected method

{@inheritdoc}

protected void has ( $key )
$key
hasNext() public method

{@inheritdoc}

public void hasNext ( )
hasPrevious() public method

{@inheritdoc}

public void hasPrevious ( )
postFetch() public method

{@inheritdoc}

public void postFetch ( )