Public Member Functions | |
| get ($key) | |
| getNextToken () | |
| set ($key, $value) | |
| setLimit ($limit) | |
| setPageSize ($pageSize) | |
 Public Member Functions inherited from Guzzle\Common\ToArrayInterface | |
| toArray () | |
| Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface | |
| addSubscriber (EventSubscriberInterface $subscriber) | |
| dispatch ($eventName, array $context=array()) | |
| getEventDispatcher () | |
| setEventDispatcher (EventDispatcherInterface $eventDispatcher) | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Guzzle\Common\HasDispatcherInterface | |
| static | getAllEvents () |
Detailed Description
Iterates over a paginated resource using subsequent requests in order to retrieve the entire matching result set
Definition at line 11 of file ResourceIteratorInterface.php.
Member Function Documentation
◆ get()
| Guzzle\Service\Resource\ResourceIteratorInterface::get | ( | $key | ) |
Get a data option from the iterator
- Parameters
-
string $key Key of the option to retrieve
- Returns
- mixed|null Returns NULL if not set or the value if set
Implemented in Guzzle\Service\Resource\ResourceIterator.
◆ getNextToken()
| Guzzle\Service\Resource\ResourceIteratorInterface::getNextToken | ( | ) |
Retrieve the NextToken that can be used in other iterators.
- Returns
- string Returns a NextToken
Implemented in Guzzle\Service\Resource\ResourceIterator.
◆ set()
| Guzzle\Service\Resource\ResourceIteratorInterface::set | ( | $key, | |
| $value | |||
| ) |
Set a data option on the iterator
- Parameters
-
string $key Key of the option to set mixed $value Value to set for the option
- Returns
- ResourceIteratorInterface
Implemented in Guzzle\Service\Resource\ResourceIterator.
◆ setLimit()
| Guzzle\Service\Resource\ResourceIteratorInterface::setLimit | ( | $limit | ) |
Attempt to limit the total number of resources returned by the iterator.
You may still receive more items than you specify. Set to 0 to specify no limit.
- Parameters
-
int $limit Limit amount
- Returns
- ResourceIteratorInterface
Implemented in Guzzle\Service\Resource\ResourceIterator.
◆ setPageSize()
| Guzzle\Service\Resource\ResourceIteratorInterface::setPageSize | ( | $pageSize | ) |
Attempt to limit the total number of resources retrieved per request by the iterator.
The iterator may return more than you specify in the page size argument depending on the service and underlying command implementation. Set to 0 to specify no page size limitation.
- Parameters
-
int $pageSize Limit amount
- Returns
- ResourceIteratorInterface
Implemented in Guzzle\Service\Resource\ResourceIterator.
The documentation for this interface was generated from the following file:
