A Page object wraps an API list method response and provides methods to retrieve additional pages using the page token.
- Implements
IteratorAggregate Traversable
| Constants |
| public Google |
| Methods |
| public __construct(Google Page constructor.
|
| public expandToFixedSizeCollection( $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.
|
| public getIterator() Return an iterator over the elements in the response.
|
| public getNextPage(?int $pageSize = NULL) Retrieves the next Page object using the next page token.
|
| public getNextPageToken() Returns the next page token from the response.
|
| public getPageElementCount() Return the number of elements in the response.
|
| public getRequestObject() Gets the request object used to generate the Page.
|
| public getResponseObject() Gets the API response object.
|
| public hasNextPage() Returns true if there are more pages that can be retrieved from the API.
|
| public 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.
|
| Properties |
| private $call = NULL |
| private $callable = NULL |
| private $options = NULL |
| private $pageStreamingDescriptor = NULL |
| private $pageToken = NULL |
| private $response = NULL |