Recurly v3 API

Pager implements Iterator

Interfaces, Classes and Traits

Iterator

Table of Contents

$_client  : mixed
$_current_page  : mixed
$_options  : mixed
$_path  : mixed
__construct()  : mixed
Constructor
current()  : RecurlyResource
Implementation of the Iterator interfaces `current` method.
getCount()  : string
Makes a HEAD request to the API to determine how many total records exist.
getFirst()  : RecurlyResource|null
Performs a request with the pager `limit` set to 1.
getResponse()  : Response
Getter for the Recurly HTTP Response of the current Page
key()  : mixed
Implementation of the Iterator interfaces `key` method.
next()  : void
Implementation of the Iterator interfaces `next` method.
rewind()  : void
Implementation of the Iterator interfaces `rewind` method.
take()  : array<string|int, mixed>
Performs a request with the pager `limit` set to `n` and only returns the first `n` results in the response.
valid()  : bool
Implementation of the Iterator interfaces `valid` method.
_loadNextPage()  : void
Fetches the next page from the API server.

Properties

$_client

private mixed $_client

$_current_page

private mixed $_current_page

$_options

private mixed $_options

Methods

__construct()

Constructor

public __construct(BaseClient $client, string $path[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$client : BaseClient

A \Recurly\BaseClient that can make API requests

$path : string

Tokenized path to request

$options : array<string|int, mixed> = []

Additional request parameters (including query parameters)

Return values
mixed

getCount()

Makes a HEAD request to the API to determine how many total records exist.

public getCount() : string
Return values
string

getResponse()

Getter for the Recurly HTTP Response of the current Page

public getResponse() : Response
Return values
Response

The Recurly HTTP Response

key()

Implementation of the Iterator interfaces `key` method.

public key() : mixed

Will return NULL for every iteration.

Tags
codeCoverageIgnore
Return values
mixed

next()

Implementation of the Iterator interfaces `next` method.

public next() : void
Tags
codeCoverageIgnore
Return values
void

rewind()

Implementation of the Iterator interfaces `rewind` method.

public rewind() : void

Resets the Iterator to the first page of results.

Return values
void

take()

Performs a request with the pager `limit` set to `n` and only returns the first `n` results in the response.

public take(int $n) : array<string|int, mixed>
Parameters
$n : int
Return values
array<string|int, mixed>

valid()

Implementation of the Iterator interfaces `valid` method.

public valid() : bool
Return values
bool

_loadNextPage()

Fetches the next page from the API server.

private _loadNextPage() : void
Return values
void

Search results