Overview

Packages

  • None
  • Rpc

Classes

  • Horde_Rpc
  • Horde_Rpc_ActiveSync
  • Horde_Rpc_Exception
  • Horde_Rpc_Phpgw
  • Horde_Rpc_Soap
  • Horde_Rpc_Syncml
  • Horde_Rpc_Syncml_Wbxml
  • Horde_Rpc_Translation
  • Horde_Rpc_Webdav
  • Horde_Rpc_Webdav2
  • Horde_Rpc_Xmlrpc
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Rpc_Phpgw

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.horde.org/licenses/lgpl21.

Horde_Rpc
Extended by Horde_Rpc_Phpgw
Package: Rpc
Category: Horde
Author: Michael Braun mi.braun@onlinehome.de
Located at Horde/Rpc/Phpgw.php
Methods summary
public Horde_Rpc
# __construct( Horde_Controller_Request_Http $request, array $params = array() )

XMLRPC server constructor.

XMLRPC server constructor.

Parameters

$request
request object
$params
<p>A hash containing any additional configuration or connection parameters a subclass might need.</p>

Returns

Horde_Rpc
An RPC server instance.

Overrides

Horde_Rpc::__construct()
public boolean
# authorize( )

Authorization is done by xmlrpc method system.login.

Authorization is done by xmlrpc method system.login.

Returns

boolean

Returns true if authentication is successful. Should send appropriate "not authorized" headers or other response codes/body if auth fails, and take care of exiting.

Overrides

Horde_Rpc::authorize()
public string
# getResponse( string $request )

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

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

Parameters

$request
raw request string.

Returns

string
The XML encoded response from the server.

Overrides

Horde_Rpc::getResponse()
public mixed
# _dispatcher( string $method, array $params, mixed $data )

Will be registered as the handler for all available methods and will call the appropriate function through the registry.

Will be registered as the handler for all available methods and will call the appropriate function through the registry.

Parameters

$method
The name of the method called by the RPC request.
$params
The passed parameters.
$data
Unknown.

Returns

mixed
The result of the called registry method.
public static mixed
# request( string|Horde_Url $url, string $method, Horde_Http_Client $client, array $params = null )

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

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

This statically called method is actually the XMLRPC client.

Parameters

$url
<p>The path to the XMLRPC server on the called host.</p>
$method
The method to call.
$client
The transport client
$params
<p>A hash containing any necessary parameters for the method call.</p>

Returns

mixed
The returned result from the method.

Throws

Horde_Rpc_Exception

Overrides

Horde_Rpc::request()
Methods inherited from Horde_Rpc
factory(), getInput(), getResponseContentType(), sendOutput()
Properties summary
public resource $_server

Resource handler for the XML-RPC server.

Resource handler for the XML-RPC server.

#
Properties inherited from Horde_Rpc
$_params, $_requestMissingAuthorization, $_requireAuthorization
API documentation generated by ApiGen