Class \Prado\Web\Services\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 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.

Class hierarchy

\Prado\Web\Services\TRpcApiProvider

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Robin J. Rogge <rrogge@bigpoint.net>
Since: 3.2

Methods summary
`public`	`__construct(TRpcServer $rpcServer) : mixed` Constructor: informs the rpc server of the registered methods
`public`	`getRpcServer() : TRpcServer`
`public`	`processRequest() : string` Processes the request using the server
`public abstract`	`registerMethods() : mixed` Must return an array of the available methods

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`