class Page implements IteratorAggregate (View source)

A Page object wraps an API list method response and provides methods to retrieve additional pages using the page token.

Constants

FINAL_PAGE_TOKEN

Methods

__construct(Call $call, array $options, callable $callable, PageStreamingDescriptor $pageStreamingDescriptor, Message $response)

Page constructor.

bool
hasNextPage()

Returns true if there are more pages that can be retrieved from the API.

string
getNextPageToken()

Returns the next page token from the response.

getNextPage(int $pageSize = null)

Retrieves the next Page object using the next page token.

int
getPageElementCount()

Return the number of elements in the response.

getIterator()

Return an iterator over the elements in the response.

iteratePages()

Return an iterator over Page objects, beginning with this object.

mixed|Message
getRequestObject()

Gets the request object used to generate the Page.

mixed|Message
getResponseObject()

Gets the API response object.

expandToFixedSizeCollection(int $collectionSize)

Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.

Details

__construct(Call $call, array $options, callable $callable, PageStreamingDescriptor $pageStreamingDescriptor, Message $response)

Page constructor.

Parameters

Call $call
array $options
callable $callable
PageStreamingDescriptor $pageStreamingDescriptor
Message $response

bool hasNextPage()

Returns true if there are more pages that can be retrieved from the API.

Return Value

bool

string getNextPageToken()

Returns the next page token from the response.

Return Value

string

Page getNextPage(int $pageSize = null)

Retrieves the next Page object using the next page token.

Parameters

int $pageSize

Return Value

Page

Exceptions

ValidationException
ApiException

int getPageElementCount()

Return the number of elements in the response.

Return Value

int

Generator getIterator()

Return an iterator over the elements in the response.

Return Value

Generator

Generator|Page[] iteratePages()

Return an iterator over Page objects, beginning with this object.

Additional Page objects are retrieved lazily via API calls until all elements have been retrieved.

Return Value

Generator|Page[]

Exceptions

ValidationException
ApiException

mixed|Message getRequestObject()

Gets the request object used to generate the Page.

Return Value

mixed|Message

mixed|Message getResponseObject()

Gets the API response object.

Return Value

mixed|Message

FixedSizeCollection expandToFixedSizeCollection(int $collectionSize)

Returns a collection of elements with a fixed size set by the collectionSize parameter. The collection will only contain fewer than collectionSize elements if there are no more pages to be retrieved from the server.

NOTE: it is an error to call this method if an optional parameter to set the page size is not supported or has not been set in the API call that was used to create this page. It is also an error if the collectionSize parameter is less than the page size that has been set.

Parameters

int $collectionSize

Return Value

FixedSizeCollection

Exceptions

ValidationException