Class TRpcService

Description

TRpcService class

Usage: <service id="rpc" class="TRpcService"> <rpcapi id="myapi" Class="MyApi" /> </service>

Located in /Web/Services/TRpcService.php (line 26)

TComponent
   |
   --TApplicationComponent
      |
      --TService
         |
         --TRpcService
Class Constant Summary
 BASE_API_PROVIDER = 'TRpcApiProvider'
 BASE_RPC_SERVER = 'TRpcServer'
Variable Summary
Method Summary
void createApiProvider (TRpcProtocol $protocolHandler, string $providerId)
void init (TXmlElement $config)
void loadConfig ( $xml)
void run ()
Variables
array $apiProviders = array() (line 49)
  • var: containing API provider and their configured properties
  • access: protected
array $protocolHandlers = array(
'application/json' => 'TJsonRpcProtocol',
'text/xml' => 'TXmlRpcProtocol'
)
(line 41)
  • var: containing mimetype to protocol handler mappings
  • access: protected
Methods
createApiProvider (line 58)

Creates the API provider instance for the current request

  • access: public
void createApiProvider (TRpcProtocol $protocolHandler, string $providerId)
  • TRpcProtocol $protocolHandler: instance
  • string $providerId
init (line 93)

Initializes the service

  • access: public
void init (TXmlElement $config)
  • TXmlElement $config: containing the module configuration

Redefinition of:
TService::init()
Initializes the service and attaches run to the RunService event of application.
loadConfig (line 101)
  • access: public
void loadConfig ( $xml)
run (line 120)

Runs the service

  • access: public
void run ()

Redefinition of:
TService::run()
Runs the service.

Inherited Methods

Inherited From TService

TService::getEnabled()
TService::getID()
TService::init()
TService::run()
TService::setEnabled()
TService::setID()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants
BASE_API_PROVIDER = 'TRpcApiProvider' (line 31)

const string base api provider class which every API must extend

BASE_RPC_SERVER = 'TRpcServer' (line 36)

const string base RPC server implementation

Documentation generated on Mon, 25 Jun 2012 14:39:07 +0200 by phpDocumentor 1.4.3