XmlRpc/Client.php
inherited
Classes
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 [email protected] 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
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
\Zend_Http_Client $_httpClient = nullHTTP Client to use for requests
nullDetails- Type
- \Zend_Http_Client
\Zend_Http_Client_Introspector $_introspector = nullIntrospection object
nullDetails- Type
- \Zend_Http_Client_Introspector
\Zend_XmlRpc_Request $_lastRequest = nullRequest of the last method call
nullDetails- Type
- \Zend_XmlRpc_Request
\Zend_XmlRpc_Response $_lastResponse = nullResponse received from the last method call
nullDetails
array $_proxyCache = array()Proxy object for more convenient method calls
<p>of Zend_XmlRpc_Client_ServerProxy</p>array()Details- Type
- array
string $_serverAddress = Full address of the XML-RPC service
- Type
- string
- Example
- http://time.xmlrpc.com/RPC2
bool $_skipSystemLookup = falseFlag for skipping system lookup
falseDetails- Type
- bool
Methods
__construct(string $server, \Zend_Http_Client $httpClient = null) : voidCreate a new XML-RPC client to a remote server
| 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 |
_createRequest( $method, $params) : \Zend_XmlRpc_RequestCreate request object
| Name | Type | Description |
|---|---|---|
| $method | ||
| $params |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Request |
call(string $method, array $params = array()) : mixedSend an XML-RPC request to the service (for a specific method)
| Name | Type | Description |
|---|---|---|
| $method | string | Name of the method we want to call |
| $params | array | Array of parameters for the method |
| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \Zend_XmlRpc_Client_FaultException |
doRequest(\Zend_XmlRpc_Request $request, null | \Zend_XmlRpc_Response $response = null) : voidPerform an XML-RPC request and return a response.
| Name | Type | Description |
|---|---|---|
| $request | \Zend_XmlRpc_Request | |
| $response | null | \Zend_XmlRpc_Response |
| Exception | Description |
|---|---|
| \Zend_XmlRpc_Client_HttpException |
getHttpClient() : \Zend_Http_ClientGets the HTTP client object.
| Type | Description |
|---|---|
| \Zend_Http_Client |
getIntrospector() : \Zend_XmlRpc_Client_ServerIntrospectionGets the introspection object.
| Type | Description |
|---|---|
| \Zend_XmlRpc_Client_ServerIntrospection |
getLastRequest() : \Zend_XmlRpc_RequestThe request of the last method call
| Type | Description |
|---|---|
| \Zend_XmlRpc_Request |
getLastResponse() : \Zend_XmlRpc_ResponseThe response received from the last method call
| Type | Description |
|---|---|
| \Zend_XmlRpc_Response |
getProxy(string $namespace = '') : \Zend_XmlRpc_Client_ServerProxyReturns a proxy object for more convenient method calls
| Name | Type | Description |
|---|---|---|
| $namespace | string | Namespace to proxy or empty string for none |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Client_ServerProxy |
setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Http_ClientSets the HTTP client object to use for connecting the XML-RPC server.
| Name | Type | Description |
|---|---|---|
| $httpClient | \Zend_Http_Client |
| Type | Description |
|---|---|
| \Zend_Http_Client |
setIntrospector( $introspector) : \Zend_XmlRpc_Client_ServerIntrospectionSets the object used to introspect remote servers
| Name | Type | Description |
|---|---|---|
| $introspector | Zend_XmlRpc_Client_ServerIntrospection |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Client_ServerIntrospection |
setSkipSystemLookup(bool $flag = true) : \Zend_XmlRpc_ClientSet skip system lookup flag
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_XmlRpc_Client |
skipSystemLookup() : boolSkip system lookup when determining if parameter should be array or struct?
| Type | Description |
|---|---|
| bool |