PHP Class Recurly_Pager, recurly-client-php

The pager moves forward only and can rewind to the first item.

Inheritance: extends Recurly_Base, implements Iterator

Protected Properties

Property	Type	Description
$_count		position within the current page
$_objects		total number of records

Method	Description
__toString ( )
count ( ) : integer	Number of records in this list.
current ( ) : Recurly_Resource	The current object
key ( ) : integer
next ( )	Increments the position to the next element
rewind ( )	Rewind to the beginning
valid ( ) : boolean

Method	Description
_afterParseResponse ( $response, $uri )
_loadFrom ( $uri )	Load another page of results into this pager.
_setState ( $params, $state )
updateErrorAttributes ( )

Method	Description
_loadLinks ( $response )	The 'Links' header contains links to the next, previous, and starting pages.
_loadRecordCount ( $response )	Find the total number of results in the collection from the 'X-Records' header.

public __toString ( )

protected _afterParseResponse ( $response, $uri )

Load another page of results into this pager.

protected _loadFrom ( $uri )

protected static _setState ( $params, $state )

Number of records in this list.

public count ( ) : integer
return	integer	number of records in list

The current object

public current ( ) : Recurly_Resource
return	Recurly_Resource	the current object

public key ( ) : integer
return	integer	current position within the current page

Increments the position to the next element

public next ( )

Rewind to the beginning

public rewind ( )

protected updateErrorAttributes ( )

public valid ( ) : boolean
return	boolean	True if the current position is valid.

position within the current page

protected $_count

total number of records

protected $_objects