model/modx/modmanagerrequest.class.php

Includes Classes

package: modx
Classes: modManagerRequest

Description

modManagerRequest

\modManagerRequest
jump to top

Extends from: \modRequest
package: modx
Properties: $action; $actionVar; $defaultAction; $error
Methods: __construct; handleRequest; initialize; loadActionMap; loadErrorHandler; prepareResponse

Description

Encapsulates the interaction of MODX manager with an HTTP request.

{@inheritdoc}

Properties

$actionThe action to load.
jump to class

string $action = 'null'

Details

: string
The action to load.
visibility: public
default: null
final: false
static: false
access: public

$actionVarThe REQUEST parameter to load actions by.
jump to class

string $actionVar = 'a'

Details

: string
The REQUEST parameter to load actions by.
visibility: public
default: a
final: false
static: false
access: public

$defaultActionThe default action to load from.
jump to class

mixed $defaultAction = '0'

Details

: mixed
The default action to load from.
visibility: public
default: 0
final: false
static: false
access: public

$errorThe error handler for the request.
jump to class

\modError $error = 'null'

Details

: \modError
The error handler for the request.
visibility: public
default: null
final: false
static: false
access: public
deprecated: 2.0.0 Use $modx->error instead.

Methods

__construct
jump to class

__construct(
           $modx
          )
        
        :

Instantiates a modManagerRequest object.

{@inheritdoc}

Arguments

$modx

Details

visibility: public
final: false
static: false

handleRequest
jump to class

handleRequest(
          
          )
        
        :
        boolean

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

Output

boolean: True if a request is handled without interruption.

Details

visibility: public
final: false
static: false
access: public

initialize
jump to class

initialize(
          
          )
        
        :
        boolean

Initializes the manager request.

Output

boolean: True if successful.

Details

visibility: public
final: false
static: false
access: public

loadActionMap
jump to class

loadActionMap(
          
          )
        
        :
        boolean

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

Output

boolean: True if successful.

Details

visibility: public
final: false
static: false
access: public

loadErrorHandler
jump to class

loadErrorHandler(
          string $class
              =
              modError
          )
        
        :

{@inheritdoc}

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

Arguments

$class: string
The class to use as the error handler.

Details

visibility: public
final: false
static: false

prepareResponse
jump to class

prepareResponse(
          array $options
              =
              array
          )
        
        :
        boolean

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

Arguments

$options: array
An array of options

Output

boolean: True if the response is properly prepared.

Details

visibility: public
final: false
static: false
access: public

model/modx/modmanagerrequest.class.php

Description

\modManagerRequestjump to top

Description

Properties

$actionThe action to load.jump to class

Details

$actionVarThe REQUEST parameter to load actions by.jump to class

Details

$defaultActionThe default action to load from.jump to class

Details

$errorThe error handler for the request.jump to class

Details

Methods

__constructjump to class

Arguments

Details

handleRequestjump to class

Output

Details

initializejump to class

Output

Details

loadActionMapjump to class

Output

Details

loadErrorHandlerjump to class

Arguments

Details

prepareResponsejump to class

Arguments

Output

Details

\modManagerRequest
jump to top

$actionThe action to load.
jump to class

$actionVarThe REQUEST parameter to load actions by.
jump to class

$defaultActionThe default action to load from.
jump to class

$errorThe error handler for the request.
jump to class

__construct
jump to class

handleRequest
jump to class

initialize
jump to class

loadActionMap
jump to class

loadErrorHandler
jump to class

prepareResponse
jump to class