XmlRpc/Client.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_XmlRpc
subpackage: Client
version: $Id: Client.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_XmlRpc_Client

Description

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.

Zend_XmlRpc_Client
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_XmlRpc
subpackage: Client
Properties: $_serverAddress; $_httpClient; $_introspector; $_lastRequest; $_lastResponse; $_proxyCache; $_skipSystemLookup
Methods: __construct; setHttpClient; getHttpClient; setIntrospector; getIntrospector; getLastRequest; getLastResponse; getProxy; setSkipSystemLookup; skipSystemLookup; doRequest; call; _createRequest

Description

An XML-RPC client implementation

Properties

$_httpClient
jump to class

Zend_Http_Client $_httpClient = 'null'

HTTP Client to use for requests

Details

$_httpClient: Zend_Http_Client
visibility: protected
default: null
final: false
static: false

$_introspector
jump to class

Zend_Http_Client_Introspector $_introspector = 'null'

Introspection object

Details

$_introspector: Zend_Http_Client_Introspector
visibility: protected
default: null
final: false
static: false

$_lastRequest
jump to class

Zend_XmlRpc_Request $_lastRequest = 'null'

Request of the last method call

Details

$_lastRequest: Zend_XmlRpc_Request
visibility: protected
default: null
final: false
static: false

$_lastResponse
jump to class

Zend_XmlRpc_Response $_lastResponse = 'null'

Response received from the last method call

Details

$_lastResponse: Zend_XmlRpc_Response
visibility: protected
default: null
final: false
static: false

$_proxyCache
jump to class

array $_proxyCache = 'array'

Proxy object for more convenient method calls

Details

$_proxyCache: array
of Zend_XmlRpc_Client_ServerProxy
visibility: protected
default: array
final: false
static: false

$_serverAddress
jump to class

string $_serverAddress = ''

Full address of the XML-RPC service

Details

$_serverAddress: string
visibility: protected
default
final: false
static: false
example: http://time.xmlrpc.com/RPC2

$_skipSystemLookup
jump to class

bool $_skipSystemLookup = 'false'

Flag for skipping system lookup

Details

$_skipSystemLookup: bool
visibility: protected
default: false
final: false
static: false

Methods

__construct
jump to class

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

Create a new XML-RPC client to a remote server

Arguments

$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

Details

visibility: public
final: false
static: false

_createRequest
jump to class

_createRequest(
           $method,  $params
          )
        
        :
        Zend_XmlRpc_Request

Create request object

Arguments

$method
$params

Output

Zend_XmlRpc_Request

Details

visibility: protected
final: false
static: false

call
jump to class

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

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

Arguments

$method: string
Name of the method we want to call
$params: array
Array of parameters for the method

Output

mixed

Details

visibility: public
final: false
static: false
throws

doRequest
jump to class

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

Perform an XML-RPC request and return a response.

Arguments

$request: Zend_XmlRpc_Request
$response: nullZend_XmlRpc_Response

Details

visibility: public
final: false
static: false
throws

getHttpClient
jump to class

getHttpClient(
          
          )
        
        :
        Zend_Http_Client

Gets the HTTP client object.

Output

Zend_Http_Client

Details

visibility: public
final: false
static: false

getIntrospector
jump to class

getIntrospector(
          
          )
        
        :
        Zend_XmlRpc_Client_ServerIntrospection

Gets the introspection object.

Output

Zend_XmlRpc_Client_ServerIntrospection

Details

visibility: public
final: false
static: false

getLastRequest
jump to class

getLastRequest(
          
          )
        
        :
        Zend_XmlRpc_Request

The request of the last method call

Output

Zend_XmlRpc_Request

Details

visibility: public
final: false
static: false

getLastResponse
jump to class

getLastResponse(
          
          )
        
        :
        Zend_XmlRpc_Response

The response received from the last method call

Output

Zend_XmlRpc_Response

Details

visibility: public
final: false
static: false

getProxy
jump to class

getProxy(
          $namespace $namespace
          )
        
        :
        Zend_XmlRpc_Client_ServerProxy

Returns a proxy object for more convenient method calls

Arguments

$namespace: $namespace
Namespace to proxy or empty string for none

Output

Zend_XmlRpc_Client_ServerProxy

Details

visibility: public
final: false
static: false

setHttpClient
jump to class

setHttpClient(
          Zend_Http_Client $httpClient
          )
        
        :
        Zend_Http_Client

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

Arguments

$httpClient: Zend_Http_Client

Output

Zend_Http_Client

Details

visibility: public
final: false
static: false

setIntrospector
jump to class

setIntrospector(
           $introspector
          )
        
        :
        Zend_XmlRpc_Client_ServerIntrospection

Sets the object used to introspect remote servers

Arguments

$introspector: Zend_XmlRpc_Client_ServerIntrospection

Output

Zend_XmlRpc_Client_ServerIntrospection

Details

visibility: public
final: false
static: false

setSkipSystemLookup
jump to class

setSkipSystemLookup(
          bool $flag
              =
              true
          )
        
        :
        Zend_XmlRpc_Client

Set skip system lookup flag

Arguments

$flag: bool

Output

Zend_XmlRpc_Client

Details

visibility: public
final: false
static: false

skipSystemLookup
jump to class

skipSystemLookup(
          
          )
        
        :
        bool

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

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

XmlRpc/Client.php

Description

Zend_XmlRpc_Clientjump to top

Description

Properties

$_httpClientjump to class

Details

$_introspectorjump to class

Details

$_lastRequestjump to class

Details

$_lastResponsejump to class

Details

$_proxyCachejump to class

Details

$_serverAddressjump to class

Details

$_skipSystemLookupjump to class

Details

Methods

__constructjump to class

Arguments

Details

_createRequestjump to class

Arguments

Output

Details

calljump to class

Arguments

Output

Details

doRequestjump to class

Arguments

Details

getHttpClientjump to class

Output

Details

getIntrospectorjump to class

Output

Details

getLastRequestjump to class

Output

Details

getLastResponsejump to class

Output

Details

getProxyjump to class

Arguments

Output

Details

setHttpClientjump to class

Arguments

Output

Details

setIntrospectorjump to class

Arguments

Output

Details

setSkipSystemLookupjump to class

Arguments

Output

Details

skipSystemLookupjump to class

Output

Details

Zend_XmlRpc_Client
jump to top

$_httpClient
jump to class

$_introspector
jump to class

$_lastRequest
jump to class

$_lastResponse
jump to class

$_proxyCache
jump to class

$_serverAddress
jump to class

$_skipSystemLookup
jump to class

__construct
jump to class

_createRequest
jump to class

call
jump to class

doRequest
jump to class

getHttpClient
jump to class

getIntrospector
jump to class

getLastRequest
jump to class

getLastResponse
jump to class

getProxy
jump to class

setHttpClient
jump to class

setIntrospector
jump to class

setSkipSystemLookup
jump to class

skipSystemLookup
jump to class