Docs For Class RequestHandler

Description

The job of a RequestHandler is twofold:

1) handle incoming request data -- could be from $_REQUEST-type arrays, could be from session variables, etc. 2) handle the production of URLs with given contextual data/query using an associated URLWriter class.

version: $Id: RequestHandler.interface.php,v 1.3 2007/09/04 20:25:31 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/architecture/request/RequestHandler.interface.php (line 28)

Direct descendents

Class	Description
GETMethodRequestHandler	The job of a RequestHandler is twofold:
PathInfoRequestHandler	<##>

Method Summary

ref createURLWriter ()

array getFileVariables ()

string getRequestedModuleAction ()

array getRequestVariables ()

Methods

createURLWriter (line 59)

Returns a new URLWriter object corresponding to this RequestHandler.

return: object URLWriter
access: public

ref createURLWriter ()

Redefined in descendants as:

GETMethodRequestHandler::createURLWriter() : Returns a new URLWriter object corresponding to this RequestHandler.
PathInfoRequestHandler::createURLWriter() : Returns a new URLWriter object corresponding to this RequestHandler.

getFileVariables (line 49)

Returns an associative array of file upload data. This will usually come from the $_FILES superglobal.

access: public

array getFileVariables ()

Redefined in descendants as:

GETMethodRequestHandler::getFileVariables() : Returns an associative array of file upload data. This will usually come from the $_FILES superglobal.
PathInfoRequestHandler::getFileVariables() : Returns an associative array of file upload data. This will usually come from the $_FILES superglobal.

getRequestedModuleAction (line 70)

Returns a dotted-pair string representing the module and action requested by the end user ("module.action" format).

access: public

string getRequestedModuleAction ()

Redefined in descendants as:

GETMethodRequestHandler::getRequestedModuleAction() : Returns a dotted-pair string representing the module and action requested by the end user ("module.action" format).
PathInfoRequestHandler::getRequestedModuleAction() : Returns a dotted-pair string representing the module and action requested by the end user ("module.action" format).

getRequestVariables (line 38)

Returns an associative array of key=value pairs corresponding to the request data from the browser. This could just be the data from $_REQUEST, in the simplest case.

access: public

array getRequestVariables ()

Redefined in descendants as:

GETMethodRequestHandler::getRequestVariables() : Returns an associative array of key=value pairs corresponding to the request data from the browser. This could just be the data from $_REQUEST, in the simplest case.
PathInfoRequestHandler::getRequestVariables() : Returns an associative array of key=value pairs corresponding to the request data from the browser. This could just be the data from $_REQUEST, in the simplest case.