Class modConnectorRequest

Description

This is the Connector Request handler for MODx.

It serves to redirect connector requests to their appropriate processors, while validating for security.

Located in /model/modx/modconnectorrequest.class.php (line 19)

modRequest
   |
   --modManagerRequest
      |
      --modConnectorRequest
Variable Summary
 string $location
Method Summary
 void handleRequest ([ $options = array()], string $location, string $action)
 void initialize ()
 void prepareResponse ([ $options = array()])
 void setDirectory ([string $dir = ''])
Variables
string $location (line 25)

The base subdirectory location of the requested action.

  • access: public

Inherited Variables

Inherited from modManagerRequest

modManagerRequest::$action
modManagerRequest::$actionVar
modManagerRequest::$defaultAction
modManagerRequest::$error

Inherited from modRequest

modRequest::$headers
modRequest::$method
modRequest::$modx
modRequest::$parameters
Methods
handleRequest (line 55)

Handles all requests specified by the action param and prepares for loading.

  • access: public
void handleRequest ([ $options = array()], string $location, string $action)
  • string $location: The base subdirectory in which to look for the processor.
  • string $action: The requested processor to load.
  • array $options

Redefinition of:
modManagerRequest::handleRequest()
The primary MODx manager request handler (a.k.a. controller).
initialize (line 27)
  • access: public
void initialize ()

Redefinition of:
modManagerRequest::initialize()
Initializes the manager request.
prepareResponse (line 73)

Prepares the output with the specified processor.

  • access: public
void prepareResponse ([ $options = array()])
  • array $options: An array of options

Redefinition of:
modManagerRequest::prepareResponse()
Prepares the MODx response to a mgr request that is being handled.
setDirectory (line 84)

Sets the directory to load the processors from

  • access: public
void setDirectory ([string $dir = ''])
  • string $dir: The directory to load from

Inherited Methods

Inherited From modManagerRequest

 modManagerRequest::__construct()
 modManagerRequest::handleRequest()
 modManagerRequest::initialize()
 modManagerRequest::loadActionMap()
 modManagerRequest::loadErrorHandler()
 modManagerRequest::prepareResponse()

Inherited From modRequest

 modRequest::__construct()
 modRequest::checkPublishStatus()
 modRequest::getActionIDs()
 modRequest::getAllActionIDs()
 modRequest::getHeaders()
 modRequest::getParameters()
 modRequest::getResource()
 modRequest::getResourceIdentifier()
 modRequest::getResourceMethod()
 modRequest::handleRequest()
 modRequest::loadErrorHandler()
 modRequest::prepareResponse()
 modRequest::preserveRequest()
 modRequest::registerLogging()
 modRequest::retrieveRequest()
 modRequest::sanitizeRequest()
 modRequest::_cleanResourceIdentifier()

Documentation generated on Fri, 17 Jun 2011 10:03:30 -0600 by phpDocumentor 1.4.3