Result Pager

Back to the navigation

Usage examples

Get all repositories of a organization

$client = new Github\Client();

$organizationApi = $client->api('organization');

$paginator  = new Github\ResultPager($client);
$parameters = array('github');
$result     = $paginator->fetchAll($organizationApi, 'repositories', $parameters);

Parameters of the fetchAll method:

  • The API object you're working with
  • The method of the API object you're using
  • The parameters of the method

Get the first page

$client = new Github\Client();

$organizationApi = $client->api('organization');

$paginator  = new Github\ResultPager( $client );
$parameters = array('github');
$result     = $paginator->fetch($organizationApi, 'repositories', $parameters);

Check for a next page:

$paginator->hasNext();

Get next page:

$paginator->fetchNext();

Check for previous page:

$paginator->hasPrevious();

Get previous page:

$paginator->fetchPrevious();

If you want to retrieve the pagination links (available after the call to fetch):

$paginator->getPagination();