FixedSizeCollection
class FixedSizeCollection implements IteratorAggregate (View source)
A collection of elements retrieved using one or more API calls. The collection will attempt to retrieve a fixed number of elements, and will make API calls until that fixed number is reached, or there are no more elements to retrieve.
Methods
FixedSizeCollection constructor.
Returns the number of elements in the collection. This will be equal to the collectionSize parameter used at construction unless there are no elements remaining to be retrieved.
Returns true if there are more elements that can be retrieved from the API.
Returns a page token that can be passed into the API list method to retrieve additional elements.
Retrieves the next FixedSizeCollection using one or more API calls.
Returns an iterator over the elements of the collection.
Returns an iterator over FixedSizeCollections, starting with this and making API calls as required until all of the elements have been retrieved.
Details
__construct(Page $initialPage, int $collectionSize)
FixedSizeCollection constructor.
int
getCollectionSize()
Returns the number of elements in the collection. This will be equal to the collectionSize parameter used at construction unless there are no elements remaining to be retrieved.
bool
hasNextCollection()
Returns true if there are more elements that can be retrieved from the API.
string
getNextPageToken()
Returns a page token that can be passed into the API list method to retrieve additional elements.
FixedSizeCollection
getNextCollection()
Retrieves the next FixedSizeCollection using one or more API calls.
Generator
getIterator()
Returns an iterator over the elements of the collection.
Generator|FixedSizeCollection[]
iterateCollections()
Returns an iterator over FixedSizeCollections, starting with this and making API calls as required until all of the elements have been retrieved.