XmlRpc/Client.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_XmlRpc  
Subpackage
Client  
Version
$Id: Client.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_XmlRpc_Client
jump to top

Package: Zend\XmlRpc\Client
An XML-RPC client implementation
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\Zend_Http_Client $_httpClient = null
HTTP Client to use for requests
Default valuenullDetails
Type
\Zend_Http_Client
>VPropertyprotected\Zend_Http_Client_Introspector $_introspector = null
Introspection object
Default valuenullDetails
Type
\Zend_Http_Client_Introspector
>VPropertyprotected\Zend_XmlRpc_Request $_lastRequest = null
Request of the last method call
Default valuenullDetails
Type
\Zend_XmlRpc_Request
>VPropertyprotected\Zend_XmlRpc_Response $_lastResponse = null
Response received from the last method call
Default valuenullDetails
Type
\Zend_XmlRpc_Response
>VPropertyprotectedarray $_proxyCache = array()
Proxy object for more convenient method calls
Default valuearray()Details
Type
array
>VPropertyprotectedstring $_serverAddress
Full address of the XML-RPC service
Details
Type
string
Example
http://time.xmlrpc.com/RPC2  
>VPropertyprotectedbool $_skipSystemLookup = false
Flag for skipping system lookup
Default valuefalseDetails
Type
bool

Methods

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

Create a new XML-RPC client to a remote server

Parameters
NameTypeDescription
$serverstring

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

$httpClient\Zend_Http_Client

HTTP Client to use for requests

methodprotected_createRequest( $method,  $params) : \Zend_XmlRpc_Request

Create request object

Parameters
NameTypeDescription
$method
$params
Returns
TypeDescription
\Zend_XmlRpc_Request
methodpubliccall(string $method, array $params = array()) : mixed

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

Parameters
NameTypeDescription
$methodstring

Name of the method we want to call

$paramsarray

Array of parameters for the method

Returns
TypeDescription
mixed
Throws
ExceptionDescription
\Zend_XmlRpc_Client_FaultException
methodpublicdoRequest(\Zend_XmlRpc_Request $request, null | \Zend_XmlRpc_Response $response = null) : void

Perform an XML-RPC request and return a response.

Parameters
NameTypeDescription
$request\Zend_XmlRpc_Request
$responsenull | \Zend_XmlRpc_Response
Throws
ExceptionDescription
\Zend_XmlRpc_Client_HttpException
methodpublicgetHttpClient() : \Zend_Http_Client

Gets the HTTP client object.

Returns
TypeDescription
\Zend_Http_Client
methodpublicgetIntrospector() : \Zend_XmlRpc_Client_ServerIntrospection

Gets the introspection object.

Returns
TypeDescription
\Zend_XmlRpc_Client_ServerIntrospection
methodpublicgetLastRequest() : \Zend_XmlRpc_Request

The request of the last method call

Returns
TypeDescription
\Zend_XmlRpc_Request
methodpublicgetLastResponse() : \Zend_XmlRpc_Response

The response received from the last method call

Returns
TypeDescription
\Zend_XmlRpc_Response
methodpublicgetProxy(string $namespace = '') : \Zend_XmlRpc_Client_ServerProxy

Returns a proxy object for more convenient method calls

Parameters
NameTypeDescription
$namespacestring

Namespace to proxy or empty string for none

Returns
TypeDescription
\Zend_XmlRpc_Client_ServerProxy
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Http_Client

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

Parameters
NameTypeDescription
$httpClient\Zend_Http_Client
Returns
TypeDescription
\Zend_Http_Client
methodpublicsetIntrospector(\Zend_XmlRpc_Client_ServerIntrospection $introspector) : \Zend_XmlRpc_Client_ServerIntrospection

Sets the object used to introspect remote servers

Parameters
NameTypeDescription
$introspector\Zend_XmlRpc_Client_ServerIntrospection
Returns
TypeDescription
\Zend_XmlRpc_Client_ServerIntrospection
methodpublicsetSkipSystemLookup(bool $flag = true) : \Zend_XmlRpc_Client

Set skip system lookup flag

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_XmlRpc_Client
methodpublicskipSystemLookup() : bool

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

Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.0.0a12.