An XML-RPC client implementation

category Zend
package Zend_XmlRpc
subpackage Client
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Create a new XML-RPC client to a remote server

__construct(string $server, \Zend_Http_Client $httpClient = null) : void

Parameters

$server

string

Full address of the XML-RPC service (e.g. http://time.xmlrpc.com/RPC2)

$httpClient

\Zend_Http_Client

HTTP Client to use for requests

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

call(string $method, array $params = array()) : mixed

Parameters

$method

string

Name of the method we want to call

$params

array

Array of parameters for the method

Exceptions

\Zend_XmlRpc_Client_FaultException

Returns

mixed

Perform an XML-RPC request and return a response.

doRequest(\Zend_XmlRpc_Request $request, null|\Zend_XmlRpc_Response $response = null) : void

Parameters

$request

\Zend_XmlRpc_Request

$response

null\Zend_XmlRpc_Response

Exceptions

\Zend_XmlRpc_Client_HttpException

Gets the HTTP client object.

getHttpClient() : \Zend_Http_Client

Returns

\Zend_Http_Client

Gets the introspection object.

getIntrospector() : \Zend_XmlRpc_Client_ServerIntrospection

Returns

\Zend_XmlRpc_Client_ServerIntrospection

The request of the last method call

getLastRequest() : \Zend_XmlRpc_Request

Returns

\Zend_XmlRpc_Request

The response received from the last method call

getLastResponse() : \Zend_XmlRpc_Response

Returns

\Zend_XmlRpc_Response

Returns a proxy object for more convenient method calls

getProxy(string $namespace = '') : \Zend_XmlRpc_Client_ServerProxy

Parameters

$namespace

string

Namespace to proxy or empty string for none

Returns

\Zend_XmlRpc_Client_ServerProxy

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

setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Http_Client

Parameters

$httpClient

\Zend_Http_Client

Returns

\Zend_Http_Client

Sets the object used to introspect remote servers

setIntrospector(\Zend_XmlRpc_Client_ServerIntrospection $introspector) : \Zend_XmlRpc_Client_ServerIntrospection

Parameters

$introspector

Returns

\Zend_XmlRpc_Client_ServerIntrospection

Set skip system lookup flag

setSkipSystemLookup(boolean $flag = true) : \Zend_XmlRpc_Client

Parameters

$flag

boolean

Returns

\Zend_XmlRpc_Client

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

skipSystemLookup() : boolean

Returns

boolean

Create request object

_createRequest($method, $params) : \Zend_XmlRpc_Request

Parameters

$method

$params

Returns

\Zend_XmlRpc_Request

 Properties

 

HTTP Client to use for requests

$_httpClient : \Zend_Http_Client

Default

null
 

Introspection object

$_introspector : \Zend_Http_Client_Introspector

Default

null
 

Request of the last method call

$_lastRequest : \Zend_XmlRpc_Request

Default

null
 

Response received from the last method call

$_lastResponse : \Zend_XmlRpc_Response

Default

null
 

Proxy object for more convenient method calls

$_proxyCache : array

Default

array()
 

Full address of the XML-RPC service

$_serverAddress : string

Default

example

Examples


 

Flag for skipping system lookup

$_skipSystemLookup : boolean

Default

false