Docs For Class AbstractService

Description

Base service class

This is the base class for JSRSService and AjaxService, which are classes that handle calls performed from Javascript code.

author: Marcos Pont <mpont@users.sourceforge.net>
version: $Revision$
uses: Callback

Located in /core/service/AbstractService.class.php (line 52)

PHP2Go
   |
   --AbstractService

Direct descendents

Class	Description
AjaxService	Handles AJAX remote function/method calls
JSRSService	Handles JSRS requests

Variable Summary

bool $errorHandling

Callback $fallbackHandler

string $handlerId

array $handlerParams

array $handlers

Method Summary

AbstractService AbstractService ()

bool acceptRequest ()

void handleRequest ()

void onError ()

void onInvalidHandler ()

void onMissingHandler ()

void registerHandler (string|array $handler, [string $alias = NULL])

void registerObject (object &$object, [string $methodPrefix = ''])

bool sendResponse (mixed $response)

void setErrorHandling (bool $setting)

void setFallbackHandler (string|array $handler, [string $alias = NULL])

Variables

bool $errorHandling = FALSE (line 88)

Error handling flag

access: private

Callback $fallbackHandler = NULL (line 81)

Fallback handler

access: private

string $handlerId = NULL (line 67)

Requested handler ID

access: private

array $handlerParams = array() (line 74)

Request parameters

access: private

array $handlers = array() (line 60)

Registered handlers

access: private

Methods

Constructor AbstractService (line 95)

Class constructor

AbstractService AbstractService ()

acceptRequest (line 239)

Must be implemented by child classes

access: protected

bool acceptRequest ()

Redefined in descendants as:

AjaxService::acceptRequest() : Searches for a valid handler ID in the request
JSRSService::acceptRequest() : Tries to parse context ID, handler ID and handler arguments from the request

handleRequest (line 201)

Triggers request handling and processing

Parses the request parameters. If the request is a valid request, this method tries to find a handler to handle the incoming request.

void handleRequest ()

onError (line 262)

Must be implemented by child classes

abstract:

void onError ()

Redefined in descendants as:

AjaxService::onError() : Handles errors when error handling is enabled
JSRSService::onError() : Handles errors when error handling is enabled

onInvalidHandler (line 260)

Must be implemented by child classes

abstract:

void onInvalidHandler ()

Redefined in descendants as:

AjaxService::onInvalidHandler() : Called when the requested handler is invalid
JSRSService::onInvalidHandler() : Executed when JSRS handler ID is invalid

onMissingHandler (line 258)

Must be implemented by child classes

abstract:

void onMissingHandler ()

Redefined in descendants as:

AjaxService::onMissingHandler() : Called when the handler ID is missing in the request
JSRSService::onMissingHandler() : Executed when JSRS handler ID is not found in the request

registerHandler (line 119)

Registers a new handler

The handler can be a procedural function, a class/method or an object/method pair (the last two represented by an array).

void registerHandler (string|array $handler, [string $alias = NULL])

string|array $handler: Handler spec
string $alias: Handler alias

registerObject (line 151)

Register methods of an object as handlers

A method prefix can be defined, so that only methods that respect this pattern will be recognized.

Example:

class MyHandler
{
function thisIsNotAHandler() { }
function serviceDoThis() { }
function serviceDoThat() { }
}
$handler = new MyHandler();
$service->registerObject($handler, 'service');

void registerObject (object &$object, [string $methodPrefix = ''])

object &$object: Object
string $methodPrefix: Method prefix

sendResponse (line 250)

Must be implemented by child classes

access: protected

bool sendResponse (mixed $response)

mixed $response: Response

Redefined in descendants as:

AjaxService::sendResponse() : Sends the response back
JSRSService::sendResponse() : Builds and prints the response produced by the JSRS handler

setErrorHandling (line 106)

Enables/disables error handling while calling service handlers

void setErrorHandling (bool $setting)

bool $setting: Flag value

setFallbackHandler (line 184)

Register a handler to be called when an invalid handler ID is requested

void setFallbackHandler (string|array $handler, [string $alias = NULL])

string|array $handler: Handler spec
string $alias: Handler alias

Inherited Methods

Inherited From PHP2Go

PHP2Go::PHP2Go()
PHP2Go::equals()
PHP2Go::generateUniqueId()
PHP2Go::getClassName()
PHP2Go::getConfigVal()
PHP2Go::getLangVal()
PHP2Go::getObjectName()
PHP2Go::getParentName()
PHP2Go::hasDestructor()
PHP2Go::hashCode()
PHP2Go::isA()
PHP2Go::isSubclassOf()
PHP2Go::logError()
PHP2Go::raiseError()
PHP2Go::registerDestructor()
PHP2Go::registerShutdownFunc()
PHP2Go::retrieve()
PHP2Go::store()
PHP2Go::__toString()