\Clx\Xms\ApiPages

A paged result.

It is possible to, e.g., fetch individual pages or iterate over all pages.

Summary

Methods
Properties
Constants
__construct()
get()
getIterator()
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(callable  $worker) 

Creates a new pages object with the given page fetcher.

This is mainly intended for internal use.

Parameters

callable $worker

a page fetcher

get()

get(integer  $page) : \Clx\Xms\Api\Page

Downloads a specific page.

Parameters

integer $page

number of the page to fetch

Returns

\Clx\Xms\Api\Page

a page

getIterator()

getIterator() : \Iterator

Returns an iterator over these pages.

Returns

\Iterator —

an iterator