\Clx\Xms\ApiPagesIterator

An iterator over a paged result.

The key is the page number and the value corresponds to the content of the pages.

Summary

Methods
Properties
Constants
__construct()
rewind()
current()
key()
next()
valid()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(\Clx\Xms\Api\Pages  $pages) 

Creates a new pages iterator for the given object.

Parameters

\Clx\Xms\Api\Pages $pages

the pages to iterate over

rewind()

rewind() : void

Rewinds the iterator.

current()

current() : \Clx\Xms\Api\Page

Returns the current page.

Returns

\Clx\Xms\Api\Page

the current page

key()

key() : integer

Returns the current page number.

Returns

integer —

the current page number

next()

next() : void

Steps this iterator to the next page.

valid()

valid() : boolean

Whether this iterator is currently valid.

Returns

boolean —

true if valid, false otherwise