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
Afficher le fichier Open project: recurly/recurly-client-php Class Usage Examples

Protected Properties

Свойство Type Description
$_count position within the current page
$_objects total number of records

Méthodes publiques

Méthode 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

Méthodes protégées

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

Private Methods

Méthode 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.

Method Details

__toString() public méthode

public __toString ( )

_afterParseResponse() protected méthode

protected _afterParseResponse ( $response, $uri )

_loadFrom() protected méthode

Load another page of results into this pager.
protected _loadFrom ( $uri )

_setState() protected static méthode

protected static _setState ( $params, $state )

count() public méthode

Number of records in this list.
public count ( ) : integer
Résultat integer number of records in list

current() public méthode

The current object
public current ( ) : Recurly_Resource
Résultat Recurly_Resource the current object

key() public méthode

public key ( ) : integer
Résultat integer current position within the current page

next() public méthode

Increments the position to the next element
public next ( )

rewind() public méthode

Rewind to the beginning
public rewind ( )

updateErrorAttributes() protected méthode

protected updateErrorAttributes ( )

valid() public méthode

public valid ( ) : boolean
Résultat boolean True if the current position is valid.

Property Details

$_count protected_oe property

position within the current page
protected $_count

$_objects protected_oe property

total number of records
protected $_objects