PHP Class Recurly_Base, recurly-client-php

Mostra file Open project: recurly/recurly-client-php Class Usage Examples

Public Properties

Property Type Description
$class_map Mapping of XML node to PHP object name

Protected Properties

Property Type Description
$_client
$_href
$_links

Public Methods

Method Description
__construct ( $href = null, $client = null )
__toString ( ) Pretty string version of the object
_get ( $uri, $client = null ) Request the URI, validate the response and return the object.
getHref ( )
getLinks ( )
setHref ( $href )

Protected Methods

Method Description
__parseResponseToNewObject ( $response, $uri, $client ) Use a valid Recurly_Response to populate a new object.
__parseXmlToObject ( $node, &$object )
__parseXmlToUpdateObject ( $xml ) Use the XML to update $this object.
__valuesString ( )
_afterParseResponse ( $response, $uri ) Optional method to allow objects access to the full response with headers.
_delete ( $uri, $client = null ) Delete the URI, validate the response and return the object.
_post ( $uri, $data = null, $client = null ) Post to the URI, validate the response and return the object.
_put ( $uri, $client = null ) Put to the URI, validate the response and return the object.
_uriWithParams ( $uri, $params = null )

Private Methods

Method Description
__createNodeObject ( $node )
addLink ( $name, $href, $method )
parseErrorNode ( $node )

Method Details

__construct() public method

public __construct ( $href = null, $client = null )

__parseResponseToNewObject() protected static method

Use a valid Recurly_Response to populate a new object.
protected static __parseResponseToNewObject ( $response, $uri, $client )

__parseXmlToObject() protected static method

protected static __parseXmlToObject ( $node, &$object )

__parseXmlToUpdateObject() protected method

Use the XML to update $this object.
protected __parseXmlToUpdateObject ( $xml )

__toString() public method

Pretty string version of the object
public __toString ( )

__valuesString() protected method

protected __valuesString ( )

_afterParseResponse() protected method

Optional method to allow objects access to the full response with headers.
protected _afterParseResponse ( $response, $uri )

_delete() protected static method

Delete the URI, validate the response and return the object.
protected static _delete ( $uri, $client = null )

_get() public static method

Request the URI, validate the response and return the object.
public static _get ( $uri, $client = null )

_post() protected static method

Post to the URI, validate the response and return the object.
protected static _post ( $uri, $data = null, $client = null )

_put() protected static method

Put to the URI, validate the response and return the object.
protected static _put ( $uri, $client = null )

_uriWithParams() protected static method

protected static _uriWithParams ( $uri, $params = null )

getHref() public method

public getHref ( )

setHref() public method

public setHref ( $href )

Property Details

$_client protected_oe property

protected $_client

$_href protected_oe property

protected $_href

$_links protected_oe property

protected $_links

$class_map static_oe public_oe property

Mapping of XML node to PHP object name
static public $class_map