Class Horde_RPC_phpgw

Description

The Horde_RPC_phpgw class provides an XMLRPC implementation of the Horde RPC system compatible with phpgw. It is based on the xmlrpc.php implementation by Jan Schneider.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /RPC/RPC/phpgw.php (line 14)

Horde_RPC
   |
   --Horde_RPC_phpgw
Variable Summary
 resource $_server
Method Summary
 Horde_RPC_phpgw Horde_RPC_phpgw ()
 void authorize ()
 string getResponse (string $request)
 mixed request (string $url, string $method, [array $params = null], [$options $options = array()])
Variables
resource $_server (line 21)

Resource handler for the XML-RPC server.

Inherited Variables

Inherited from Horde_RPC

Horde_RPC::$_params
Horde_RPC::$_requestMissingAuthorization
Horde_RPC::$_requireAuthorization
Methods
Constructor Horde_RPC_phpgw (line 26)

XMLRPC server constructor.

Horde_RPC_phpgw Horde_RPC_phpgw ()
authorize (line 44)

Authorization is done by xmlrpc method system.login.

void authorize ()

Redefinition of:
Horde_RPC::authorize()
Check authentication. Different backends may handle authentication in different ways. The base class implementation checks for HTTP Authentication against the Horde auth setup.
getResponse (line 56)

Sends an RPC request to the server and returns the result.

  • return: The XML encoded response from the server.
string getResponse (string $request)
  • string $request: The raw request string.

Redefinition of:
Horde_RPC::getResponse()
Sends an RPC request to the server and returns the result.
request (line 138)

Builds an XMLRPC request and sends it to the XMLRPC server.

This statically called method is actually the XMLRPC client.

  • return: The returned result from the method or a PEAR error object on failure.
mixed request (string $url, string $method, [array $params = null], [$options $options = array()])
  • string $url: The path to the XMLRPC server on the called host.
  • string $method: The method to call.
  • array $params: A hash containing any necessary parameters for the method call.
  • $options $options: Optional associative array of parameters which can be: user - Basic Auth username pass - Basic Auth password proxy_host - Proxy server host proxy_port - Proxy server port proxy_user - Proxy auth username proxy_pass - Proxy auth password timeout - Connection timeout in seconds. allowRedirects - Whether to follow redirects or not maxRedirects - Max number of redirects to follow

Redefinition of:
Horde_RPC::request()
Builds an RPC request and sends it to the RPC server.

Inherited Methods

Inherited From Horde_RPC

 Horde_RPC::Horde_RPC()
 Horde_RPC::authorize()
 Horde_RPC::factory()
 Horde_RPC::getInput()
 Horde_RPC::getResponse()
 Horde_RPC::getResponseContentType()
 Horde_RPC::request()

Documentation generated on Sun, 30 Jan 2011 05:20:37 +0000 by phpDocumentor 1.4.3