Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_XmlRpc_Client Class Reference

Public Member Functions

 __construct ($server, Zend_Http_Client $httpClient=null)
 Create a new XML-RPC client to a remote server.
 
 setHttpClient (Zend_Http_Client $httpClient)
 Sets the HTTP client object to use for connecting the XML-RPC server.
 
 getHttpClient ()
 Gets the HTTP client object.
 
 setIntrospector (Zend_XmlRpc_Client_ServerIntrospection $introspector)
 Sets the object used to introspect remote servers.
 
 getIntrospector ()
 Gets the introspection object.
 
 getLastRequest ()
 The request of the last method call.
 
 getLastResponse ()
 The response received from the last method call.
 
 getProxy ($namespace= '')
 Returns a proxy object for more convenient method calls.
 
 setSkipSystemLookup ($flag=true)
 Set skip system lookup flag.
 
 skipSystemLookup ()
 Skip system lookup when determining if parameter should be array or struct?
 
 doRequest ($request, $response=null)
 Perform an XML-RPC request and return a response.
 
 call ($method, $params=array())
 Send an XML-RPC request to the service (for a specific method)
 

Protected Member Functions

 _createRequest ($method, $params)
 Create request object.
 

Protected Attributes

 $_serverAddress
 
 $_httpClient = null
 
 $_introspector = null
 
 $_lastRequest = null
 
 $_lastResponse = null
 
 $_proxyCache = array()
 
 $_skipSystemLookup = false
 

Constructor & Destructor Documentation

__construct (   $server,
Zend_Http_Client  $httpClient = null 
)

Create a new XML-RPC client to a remote server.

Parameters
string$serverFull address of the XML-RPC service (e.g. http://time.xmlrpc.com/RPC2)
Zend_Http_Client$httpClientHTTP Client to use for requests
Returns
void

Member Function Documentation

_createRequest (   $method,
  $params 
)
protected

Create request object.

Returns
Zend_XmlRpc_Request
call (   $method,
  $params = array() 
)

Send an XML-RPC request to the service (for a specific method)

Parameters
string$methodName of the method we want to call
array$paramsArray of parameters for the method
Returns
mixed
Exceptions
Zend_XmlRpc_Client_FaultException

Exception thrown when an XML-RPC fault is returned

See Also
Zend_XmlRpc_Client_FaultException
doRequest (   $request,
  $response = null 
)

Perform an XML-RPC request and return a response.

Parameters
Zend_XmlRpc_Request$request
null | Zend_XmlRpc_Response$response
Returns
void
Exceptions
Zend_XmlRpc_Client_HttpException

Exception thrown when an HTTP error occurs

See Also
Zend_XmlRpc_Client_HttpException
getHttpClient ( )

Gets the HTTP client object.

Returns
Zend_Http_Client
getIntrospector ( )

Gets the introspection object.

Returns
Zend_XmlRpc_Client_ServerIntrospection
getLastRequest ( )

The request of the last method call.

Returns
Zend_XmlRpc_Request
getLastResponse ( )

The response received from the last method call.

Returns
Zend_XmlRpc_Response
getProxy (   $namespace = '')

Returns a proxy object for more convenient method calls.

Parameters
string$namespaceNamespace to proxy or empty string for none
Returns
Zend_XmlRpc_Client_ServerProxy
setHttpClient ( Zend_Http_Client  $httpClient)

Sets the HTTP client object to use for connecting the XML-RPC server.

Parameters
Zend_Http_Client$httpClient
Returns
Zend_Http_Client
setIntrospector ( Zend_XmlRpc_Client_ServerIntrospection  $introspector)

Sets the object used to introspect remote servers.

Parameters
Zend_XmlRpc_Client_ServerIntrospection
Returns
Zend_XmlRpc_Client_ServerIntrospection
setSkipSystemLookup (   $flag = true)

Set skip system lookup flag.

Parameters
bool$flag
Returns
Zend_XmlRpc_Client
skipSystemLookup ( )

Skip system lookup when determining if parameter should be array or struct?

Returns
bool

Member Data Documentation

$_httpClient = null
protected
$_introspector = null
protected
$_lastRequest = null
protected
$_lastResponse = null
protected
$_proxyCache = array()
protected
$_serverAddress
protected
$_skipSystemLookup = false
protected