Docs For Class SGL_Services_REST

Description

Parent class for implementing a REST client, override and customise.

Located in /SGL/Services/REST/Client.php (line 27)

Variable Summary

mixed $_aOptions

string $_apiUrl

mixed $_clientName

mixed $_entityName

mixed $_getRequest

string $_passwd

mixed $_responseXml

object XML_Unserializer $_us

string $_user

Method Summary

SGL_Services_REST_Client SGL_Services_REST_Client ([ $aOptions = array()], [string $user = null], [string $passwd = null])

void getComplexTypes ()

void getEntityName ()

void getKeysToIgnore ()

void getOption ( $optionName)

void getRawRequest ()

void getResponseXml ()

void setEntityName ( $name)

void setOptions ( $aOptions)

array|PEAR_Error _getRequest (string $verb, [array $params = array()])

void _postRequest ( $verb, [ $params = array()], $oData)

void _processResponse ( $request)

Variables

mixed $_aOptions = array() (line 63)

string $_apiUrl = '' (line 35)

URI of the REST API

access: private

mixed $_clientName = 'SGL_Services_REST_Client' (line 61)

mixed $_entityName = '' (line 65)

mixed $_getRequest = '' (line 69)

string $_passwd = null (line 51)

password

access: private

mixed $_responseXml = '' (line 67)

object XML_Unserializer $_us = null (line 59)

XML_Unserializer, used to parse the XML

access: private

string $_user = null (line 43)

Username

access: private

Methods

Constructor SGL_Services_REST_Client (line 78)

Constructor.

SGL_Services_REST_Client SGL_Services_REST_Client ([ $aOptions = array()], [string $user = null], [string $passwd = null])

string $user
string $passwd
$aOptions

getComplexTypes (line 223)

void getComplexTypes ()

getEntityName (line 229)

void getEntityName ()

getKeysToIgnore (line 217)

void getKeysToIgnore ()

getOption (line 94)

void getOption ( $optionName)

$optionName

getRawRequest (line 212)

void getRawRequest ()

getResponseXml (line 207)

void getResponseXml ()

setEntityName (line 234)

void setEntityName ( $name)

$name

setOptions (line 87)

void setOptions ( $aOptions)

$aOptions

_getRequest (line 113)

Auxiliary method to send a request.

access: private

array|PEAR_Error _getRequest (string $verb, [array $params = array()])

string $verb: REST verb
array $params: parameters

_postRequest (line 150)

void _postRequest ( $verb, [ $params = array()], $oData)

$verb
$params
$oData

_processResponse (line 188)

void _processResponse ( $request)

$request