Docs For Class modManagerRequest

Description

Encapsulates the interaction of MODx manager with an HTTP request.

This class represents the functional portion of the MODx front- controller, and is responsible for sanitizing, interpretting, and dispatching a web request to the appropriate MODx Web Resource.

Located in /model/modx/modmanagerrequest.class.php (line 15)

modRequest
   |
   --modManagerRequest

Direct descendents

Class	Description
modConnectorRequest	This is the Connector Request handler for MODx.

Variable Summary

string $action

string $actionVar

mixed $defaultAction

modError $error

Method Summary

modManagerRequest __construct (modX &$modx)

boolean handleRequest ()

boolean initialize ()

boolean loadActionMap ()

void loadErrorHandler ([ $class = 'modError'])

boolean prepareResponse ([ $options = array()])

Variables

string $action = null (line 20)

var: The action to load.
access: public

string $actionVar = 'a' (line 31)

var: The REQUEST parameter to load actions by.
access: public

mixed $defaultAction = 0 (line 36)

var: The default action to load from.
access: public

modError $error = null (line 26)

var: The error handler for the request.
deprecated: 2.0.0 Use $modx->error instead.
access: public

Inherited Variables

Inherited from modRequest

modRequest::$headers
modRequest::$method
modRequest::$modx
modRequest::$parameters

Methods

Constructor __construct (line 43)

Instantiates a modManagerRequest object.

modManagerRequest __construct (modX &$modx)

modX &$modx

Redefinition of:

modRequest::__construct()

handleRequest (line 148)

The primary MODx manager request handler (a.k.a. controller).

return: True if a request is handled without interruption.
access: public

boolean handleRequest ()

Redefinition of:

modRequest::handleRequest(): The primary MODx request handler (a.k.a. controller).

Redefined in descendants as:

modConnectorRequest::handleRequest() : Handles all requests specified by the action param and prepares for loading.

initialize (line 54)

Initializes the manager request.

return: True if successful.
access: public

boolean initialize ()

Redefined in descendants as:

modConnectorRequest::initialize()

loadActionMap (line 179)

Loads the actionMap, and generates a cache file if necessary.

return: True if successful.
access: public

boolean loadActionMap ()

loadErrorHandler (line 168)

This implementation adds register logging capabilities via $_POST vars when the error handler is loaded.

access: public

void loadErrorHandler ([ $class = 'modError'])

$class

Redefinition of:

modRequest::loadErrorHandler(): Loads the error handling class for the request.

prepareResponse (line 200)

Prepares the MODx response to a mgr request that is being handled.

return: True if the response is properly prepared.
access: public

boolean prepareResponse ([ $options = array()])

array $options: An array of options

Redefinition of:

modRequest::prepareResponse(): Prepares the MODx response to a web request that is being handled.

Redefined in descendants as:

modConnectorRequest::prepareResponse() : Prepares the output with the specified processor.

Inherited Methods

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()