model/modx/modrequest.class.php

package: modx
Classes: modRequest

Description

Encapsulates the interaction of MODX with an HTTP request.

This class represents the functional portion of the MODX {@link http://www.martinfowler.com/eaaCatalog/frontController.html front- controller}, and is responsible for sanitizing, interpretting, and dispatching a web request to the appropriate MODX {@link modResource Web Resource}.

\modRequest
jump to top

package: modx
Properties: $headers; $method; $modx; $parameters
Methods: __construct; _cleanResourceIdentifier; checkPublishStatus; getActionIDs; getAllActionIDs; getClientIp; getHeaders; getParameters; getResource; getResourceIdentifier; getResourceMethod; handleRequest; loadErrorHandler; prepareResponse; preserveRequest; registerLogging; retrieveRequest; sanitizeRequest

Description

Encapsulates the interaction of MODX with an HTTP request.

Properties

$headers
jump to class

$headers = 'null'

Details

visibility: public
default: null
final: false
static: false

$method
jump to class

$method = 'null'

Details

visibility: public
default: null
final: false
static: false

$modx
jump to class

$modx = 'null'

Details

visibility: public
default: null
final: false
static: false

$parameters
jump to class

$parameters = 'null'

Details

visibility: public
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
           $modx
          )
        
        :

Arguments

$modx

Details

visibility: public
final: false
static: false

_cleanResourceIdentifier
jump to class

_cleanResourceIdentifier(
          string $identifier
          )
        
        :
        string|integer

Cleans the resource identifier from the request params.

Arguments

$identifier: string
The raw identifier.

Output

string|integer: The cleansed identifier.

Details

visibility: public
final: false
static: false

checkPublishStatus
jump to class

checkPublishStatus(
          
          )
        
        :

Checks the current status of timed publishing events.

Details

visibility: public
final: false
static: false

getActionIDs
jump to class

getActionIDs(
           $actions
              =
              array,  $namespace
              =
              core
          )
        
        :

Arguments

$actions
$namespace

Details

visibility: public
final: false
static: false

getAllActionIDs
jump to class

getAllActionIDs(
           $namespace
          )
        
        :

Arguments

$namespace

Details

visibility: public
final: false
static: false

getClientIp
jump to class

getClientIp(
          
          )
        
        :
        array

Get the true client IP. Returns an array of values:

ip - The real, true client IP
suspected - The suspected IP, if not alike to REMOTE_ADDR
network - The client's network IP

Output

array

Details

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

getHeaders
jump to class

getHeaders(
           $ucKeys
              =
              false
          )
        
        :

Arguments

$ucKeys

Details

visibility: public
final: false
static: false

getParameters
jump to class

getParameters(
          string|array $keys
              =
              array, string $type
              =
              GET
          )
        
        :

Get a GPC/REQUEST variable value or an array of values from the request.

Arguments

$keys: stringarray
A key or array of keys to retrieve from the GPC variable. An empty array means get all keys of the variable.
$type: string
The type of GPC variable, GET by default (GET, POST, COOKIE or REQUEST).

Details

visibility: public
final: false
static: false

getResource
jump to class

getResource(
          string $method, string|integer $identifier,  $options
              =
              array
          )
        
        :
        \modResource

Gets a requested resource and all required data.

Arguments

$method: string
The method, 'id', or 'alias', by which to perform the resource lookup.
$identifier: stringinteger
The identifier with which to search.
$options

Output

\modResource: The requested modResource instance or request is forwarded to the error page, or unauthorized page.

Details

visibility: public
final: false
static: false

getResourceIdentifier
jump to class

getResourceIdentifier(
          string $method
          )
        
        :
        string

Gets the idetifier used to request a resource.

Arguments

$method: string
'alias' or 'id'.

Output

string: The identifier for the requested resource.

Details

visibility: public
final: false
static: false

getResourceMethod
jump to class

getResourceMethod(
          
          )
        
        :
        string

Gets the method used to request a resource.

Output

string: 'alias', 'id', or an empty string.

Details

visibility: public
final: false
static: false

handleRequest
jump to class

handleRequest(
          
          )
        
        :
        boolean

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

Output

boolean: True if a request is handled without interruption.

Details

visibility: public
final: false
static: false

loadErrorHandler
jump to class

loadErrorHandler(
          string $class
              =
              modError
          )
        
        :

Loads the error handling class for the request.

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 web 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

preserveRequest
jump to class

preserveRequest(
          string $key
              =
              referrer
          )
        
        :

Preserves the $_REQUEST superglobal to the $_SESSION.

Arguments

$key: string
A key to save the $_REQUEST as; default is 'referrer'.

Details

visibility: public
final: false
static: false

registerLogging
jump to class

registerLogging(
          array $options
              =
              array
          )
        
        :

Provides an easy way to initiate register logging.

Through an array of options, you can have all calls to modX::log() recorded in a topic of a modRegister instance. The options include:

register: the name of the register (required)
topic: the topic to record to (required)
register_class: the modRegister class (defaults to modFileRegister)
log_level: the logging level (defaults to MODX_LOG_LEVEL_INFO)

Arguments

$options: array
An array containing all the options required to initiate and configure logging to a modRegister instance.

Details

visibility: public
final: false
static: false

retrieveRequest
jump to class

retrieveRequest(
          string $key
              =
              referrer
          )
        
        :

Retrieve's a preserved $_REQUEST from $_SESSION.

Arguments

$key: string
A key to identify a specific $_REQUEST; default is 'referrer'.

Details

visibility: public
final: false
static: false

sanitizeRequest
jump to class

sanitizeRequest(
          
          )
        
        :

Harden GPC variables by removing any MODX tags, Javascript, or entities.

Details

visibility: public
final: false
static: false

model/modx/modrequest.class.php

Description

\modRequestjump to top

Description

Properties

$headersjump to class

Details

$methodjump to class

Details

$modxjump to class

Details

$parametersjump to class

Details

Methods

__constructjump to class

Arguments

Details

_cleanResourceIdentifierjump to class

Arguments

Output

Details

checkPublishStatusjump to class

Details

getActionIDsjump to class

Arguments

Details

getAllActionIDsjump to class

Arguments

Details

getClientIpjump to class

Output

Details

getHeadersjump to class

Arguments

Details

getParametersjump to class

Arguments

Details

getResourcejump to class

Arguments

Output

Details

getResourceIdentifierjump to class

Arguments

Output

Details

getResourceMethodjump to class

Output

Details

handleRequestjump to class

Output

Details

loadErrorHandlerjump to class

Arguments

Details

prepareResponsejump to class

Arguments

Output

Details

preserveRequestjump to class

Arguments

Details

registerLoggingjump to class

Arguments

Details

retrieveRequestjump to class

Arguments

Details

sanitizeRequestjump to class

Details

\modRequest
jump to top

$headers
jump to class

$method
jump to class

$modx
jump to class

$parameters
jump to class

__construct
jump to class

_cleanResourceIdentifier
jump to class

checkPublishStatus
jump to class

getActionIDs
jump to class

getAllActionIDs
jump to class

getClientIp
jump to class

getHeaders
jump to class

getParameters
jump to class

getResource
jump to class

getResourceIdentifier
jump to class

getResourceMethod
jump to class

handleRequest
jump to class

loadErrorHandler
jump to class

prepareResponse
jump to class

preserveRequest
jump to class

registerLogging
jump to class

retrieveRequest
jump to class

sanitizeRequest
jump to class