PHP Class Prado\Web\Services\TRpcApiProvider

TRpcApiProvider is an abstract class the can be subclasses in order to implement an api for a {@link TRpcService}. A subclass of TRpcApiProvider must implement the {@link 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 {@link TRpcService}'s documentation.

Since: 3.2

Author: Robin J. Rogge ([email protected])

Inheritance: extends Prado\TModule

Show file Open project: pradosoft/prado

Protected Properties

Property	Type	Description
$rpcServer		instance

Public Methods

Method	Description
__construct ( TRpcServer $rpcServer )	Constructor: informs the rpc server of the registered methods
getRpcServer ( ) : rpc
processRequest ( ) : processed	Processes the request using the server
registerMethods ( )	Must return an array of the available methods

Method Details

__construct() public method

Constructor: informs the rpc server of the registered methods

public __construct ( TRpcServer $rpcServer )
$rpcServer	TRpcServer

getRpcServer() public method

public getRpcServer ( ) : rpc
return	rpc	server instance

processRequest() public method

Processes the request using the server

public processRequest ( ) : processed
return	processed	request

registerMethods() abstract public method

Must return an array of the available methods

abstract public registerMethods ( )

Property Details

$rpcServer protected property

instance

protected $rpcServer