model/modx/modconnectorrequest.class.php
- package
- modx
- Classes
- modConnectorRequest
Description
modConnectorRequest
\modConnectorRequest
- Extends from
- \modManagerRequest
- package
- modx
- Properties
- $location
- Methods
- handleRequest
- initialize
- prepareResponse
- setDirectory
Description
This is the Connector Request handler for MODX.
It serves to redirect connector requests to their appropriate processors, while validating for security.
Properties
$location
string $location = ''The base subdirectory location of the requested action.
Details
- string
- visibility
- public
- default
- final
- false
- static
- false
- access
- public
Methods
handleRequest
handleRequest(
$options
=
array
)
:
booleanHandles all requests specified by the action param and prepares for loading.
Arguments
- $options
Output
- boolean
- True if a request is handled without interruption.
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
initialize
initialize(
)
:
booleanInitializes the manager request.
Output
- boolean
- True if successful.
Details
- visibility
- public
- final
- false
- static
- false
prepareResponse
prepareResponse(
array $options
=
array
)
:
booleanPrepares the output with the specified processor.
Arguments
- $options
- array
An array of options
Output
- boolean
- True if the response is properly prepared.
Details
- visibility
- public
- final
- false
- static
- false
setDirectory
setDirectory(
string $dir
)
:
Sets the directory to load the processors from
Arguments
- $dir
- string
The directory to load from
Details
- visibility
- public
- final
- false
- static
- false