\Guzzle\Service\ResourceResourceIteratorInterface

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

Summary

Methods
Constants
toArray()
getAllEvents()
setEventDispatcher()
getEventDispatcher()
dispatch()
addSubscriber()
getNextToken()
setLimit()
setPageSize()
get()
set()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

toArray()

toArray() : array

Get the array representation of an object

Returns

array

getAllEvents()

getAllEvents() : array

Get a list of all of the events emitted from the class

Returns

array

dispatch()

dispatch(string  $eventName, array  $context = array()) : \Guzzle\Common\Event

Helper to dispatch Guzzle events and set the event name on the event

Parameters

string $eventName

Name of the event to dispatch

array $context

Context of the event

Returns

\Guzzle\Common\Event

Returns the created event object

getNextToken()

getNextToken() : string

Retrieve the NextToken that can be used in other iterators.

Returns

string —

Returns a NextToken

setLimit()

setLimit(integer  $limit) : \Guzzle\Service\Resource\ResourceIteratorInterface

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

integer $limit

Limit amount

Returns

\Guzzle\Service\Resource\ResourceIteratorInterface

setPageSize()

setPageSize(integer  $pageSize) : \Guzzle\Service\Resource\ResourceIteratorInterface

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

integer $pageSize

Limit amount

Returns

\Guzzle\Service\Resource\ResourceIteratorInterface

get()

get(string  $key) : mixed|null

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

set()

set(string  $key, mixed  $value) : \Guzzle\Service\Resource\ResourceIteratorInterface

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

\Guzzle\Service\Resource\ResourceIteratorInterface