API Documentation

Zend/XmlRpc/Client.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_XmlRpc_Client

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

Propertyprotected\Zend_Http_Client  $_httpClient= 'null'

HTTP Client to use for requests

Default valuenullDetails
Type
\Zend_Http_Client
Propertyprotected\Zend_Http_Client_Introspector  $_introspector= 'null'

Introspection object

Default valuenullDetails
Type
\Zend_Http_Client_Introspector
Propertyprotected\Zend_XmlRpc_Request  $_lastRequest= 'null'

Request of the last method call

Default valuenullDetails
Type
\Zend_XmlRpc_Request
Propertyprotected\Zend_XmlRpc_Response  $_lastResponse= 'null'

Response received from the last method call

Default valuenullDetails
Type
\Zend_XmlRpc_Response
Propertyprotectedarray  $_proxyCache= 'array()'

Proxy object for more convenient method calls

of Zend_XmlRpc_Client_ServerProxy
Default valuearray()Details
Type
array
Propertyprotectedstring  $_serverAddress= ''

Full address of the XML-RPC service

Details
Type
string
Example
http://time.xmlrpc.com/RPC2  
Propertyprotectedbool  $_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
Name Type Description
$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

methodprotected_createRequest(  $method,  $params ) : \Zend_XmlRpc_Request

Create request object

Parameters
Name Type Description
$method
$params
Returns
Type Description
\Zend_XmlRpc_Request
methodpubliccall( string $method, array $params = array() ) : mixed

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

Parameters
Name Type Description
$method string

Name of the method we want to call

$params array

Array of parameters for the method

Returns
Type Description
mixed
Throws
Exception Description
\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
Name Type Description
$request \Zend_XmlRpc_Request
$response null|\Zend_XmlRpc_Response
Throws
Exception Description
\Zend_XmlRpc_Client_HttpException
methodpublicgetHttpClient( ) : \Zend_Http_Client

Gets the HTTP client object.

Returns
Type Description
\Zend_Http_Client
methodpublicgetIntrospector( ) : \Zend_XmlRpc_Client_ServerIntrospection

Gets the introspection object.

Returns
Type Description
\Zend_XmlRpc_Client_ServerIntrospection
methodpublicgetLastRequest( ) : \Zend_XmlRpc_Request

The request of the last method call

Returns
Type Description
\Zend_XmlRpc_Request
methodpublicgetLastResponse( ) : \Zend_XmlRpc_Response

The response received from the last method call

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

Returns a proxy object for more convenient method calls

Parameters
Name Type Description
$namespace string

Namespace to proxy or empty string for none

Returns
Type Description
\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
Name Type Description
$httpClient \Zend_Http_Client
Returns
Type Description
\Zend_Http_Client
methodpublicsetIntrospector(  $introspector ) : \Zend_XmlRpc_Client_ServerIntrospection

Sets the object used to introspect remote servers

Parameters
Name Type Description
$introspector

Zend_XmlRpc_Client_ServerIntrospection

Returns
Type Description
\Zend_XmlRpc_Client_ServerIntrospection
methodpublicsetSkipSystemLookup( bool $flag = true ) : \Zend_XmlRpc_Client

Set skip system lookup flag

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_XmlRpc_Client
methodpublicskipSystemLookup( ) : bool

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

Returns
Type Description
bool
Documentation was generated by DocBlox 0.15.1.