Interface Guzzle\Service\Resource\ResourceIteratorInterface

ExtendsCountable, Guzzle\Common\HasDispatcherInterface, Guzzle\Common\ToArrayInterface, Iterator
Implemented byGuzzle\Service\Resource\ResourceIterator

Iterates over a paginated resource using subsequent requests in order to retrieve the entire matching result set

Public Methods

Hide inherited methods

MethodDescriptionDefined By
addSubscriber() Add an event subscriber to the dispatcher Guzzle\Common\HasDispatcherInterface
dispatch() Helper to dispatch Guzzle events and set the event name on the event Guzzle\Common\HasDispatcherInterface
get() Get a data option from the iterator Guzzle\Service\Resource\ResourceIteratorInterface
getAllEvents() Get a list of all of the events emitted from the class Guzzle\Common\HasDispatcherInterface
getEventDispatcher() Get the EventDispatcher of the request Guzzle\Common\HasDispatcherInterface
getNextToken() Retrieve the NextToken that can be used in other iterators. Guzzle\Service\Resource\ResourceIteratorInterface
set() Set a data option on the iterator Guzzle\Service\Resource\ResourceIteratorInterface
setEventDispatcher() Set the EventDispatcher of the request Guzzle\Common\HasDispatcherInterface
setLimit() Attempt to limit the total number of resources returned by the iterator. Guzzle\Service\Resource\ResourceIteratorInterface
setPageSize() Attempt to limit the total number of resources retrieved per request by the iterator. Guzzle\Service\Resource\ResourceIteratorInterface
toArray() Get the array representation of an object Guzzle\Common\ToArrayInterface

Method Details

get() public abstract method

Get a data option from the iterator

public abstract mixed|null get ( $key )
$key string

Key of the option to retrieve

return mixed|null

Returns NULL if not set or the value if set

getNextToken() public abstract method

Retrieve the NextToken that can be used in other iterators.

public abstract string getNextToken ( )
return string

Returns a NextToken

set() public abstract method

Set a data option on the iterator

public abstract Guzzle\Service\Resource\ResourceIteratorInterface set ( $key, $value )
$key string

Key of the option to set

$value mixed

Value to set for the option

setLimit() public abstract method

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.

public abstract Guzzle\Service\Resource\ResourceIteratorInterface setLimit ( $limit )
$limit int

Limit amount

setPageSize() public abstract method

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.

public abstract Guzzle\Service\Resource\ResourceIteratorInterface setPageSize ( $pageSize )
$pageSize int

Limit amount