Class TRpcApiProvider
TRpcApiProvider class
TRpcApiProvider is an abstract class the can be subclasses in order to
implement an api for a TRpcService
. A subclass of TRpcApiProvider must
implement the TRpcApiProvider::registerMethods()
method in order to declare the available
methods, their names and the associated callback.
public function registerMethods() { return array( 'apiMethodName1' => array('method' => array($this, 'objectMethodName1')), 'apiMethodName2' => array('method' => array('ClassName', 'staticMethodName')), ); }
In this example, two api method have been defined. The first refers to an object method that must be implemented in the same class, the second to a static method implemented in a 'ClassName' class. In both cases, the method implementation will receive the request parameters as its method parameters. Since the number of received parameters depends on external-supplied data, it's adviced to use php's func_get_args() funtion to validate them.
Providers must be registered in the service configuration in order to be
available, as explained in TRpcService
's documentation.
- TComponent
-
TApplicationComponent
-
TModule implements IModule
-
TRpcApiProvider
Package: System\Web\Services
Copyright: 2010 Bigpoint GmbH
License: http://www.pradosoft.com/license/
Author: Robin J. Rogge <rrogge@bigpoint.net>
Version: $Id$
Since: 3.2
Located at Web/Services/TRpcService.php
abstract public
|
|
public
|
#
__construct(
Constructor: informs the rpc server of the registered methods |
public
processed
|
|
public
rpc
|
getID(),
init(),
setID()
|
getApplication(),
getRequest(),
getResponse(),
getService(),
getSession(),
getUser(),
publishAsset(),
publishFilePath()
|
GLOBAL_RAISE_EVENT_LISTENER
|
protected
|
$rpcServer |
|
#
instance |