Docs For Class modManagerResponse

Description

Encapsulates an HTTP response from the MODx manager.

Includes functions to manipluate header data, such as status codes, as well as manipulating the response body.

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

modResponse
   |
   --modManagerResponse

Variable Summary

mixed $action

Method Summary

boolean addLangTopic (string $topic)

void checkFormCustomizationRules ([ &$obj = null], [ $forParent = false], xPDOObject $obj)

mixed getControllerFilename ([string $f = ''])

boolean getLangTopics ()

void outputContent ([ $options = array()])

string prepareNamespacePath ( $controller, [ $theme = 'default'])

void registerBaseScripts ([ $loadLayout = true])

void registerCssJs ()

boolean setLangTopics ([ $topics = array()])

string _postfixVersionToScript (string $str, string $version)

string _prepareVersionPostfix ()

Variables

mixed $action = array() (line 16)

access: public

Inherited Variables

Inherited from modResponse

modResponse::$body
modResponse::$header
modResponse::$modx

Methods

addLangTopic (line 413)

Adds a lexicon topic to this page's language topics to load. Will load the topic as well.

return: True if successful
access: public

boolean addLangTopic (string $topic)

string $topic: The topic to load, in standard namespace:topic format

checkFormCustomizationRules (line 146)

Checks Form Customization rules for an object.

access: public

void checkFormCustomizationRules ([ &$obj = null], [ $forParent = false], xPDOObject $obj)

xPDOObject $obj: If passed, will validate against for rules with constraints.
&$obj
$forParent

getControllerFilename (line 318)

Gets the parsed controller filename and checks for its existence.

return: The parsed filename, or boolean false if invalid.
access: protected

mixed getControllerFilename ([string $f = ''])

string $f: The filename to parse.

getLangTopics (line 424)

Adds a lexicon topic to this page's language topics to load

return: True if successful
access: public

boolean getLangTopics ()

outputContent (line 24)

Overrides modResponse::outputContent to provide mgr-context specific response.

access: public

void outputContent ([ $options = array()])

array $options

Redefinition of:

modResponse::outputContent(): Prepare the final response after the resource has been processed.

prepareNamespacePath (line 292)

Prepares the Namespace Path for usage

return: The formatted Namespace path
access: protected

string prepareNamespacePath ( $controller, [ $theme = 'default'])

$controller
$theme

registerBaseScripts (line 248)

Registers the core and base JS scripts

access: public

void registerBaseScripts ([ $loadLayout = true])

$loadLayout

registerCssJs (line 370)

Registers CSS/JS to manager interface

access: public

void registerCssJs ()

setLangTopics (line 434)

Sets the language topics for this page

return: True if successful
access: public

boolean setLangTopics ([ $topics = array()])

array $topics: The array of topics to set

_postfixVersionToScript (line 355)

Appends a version postfix to a script tag

return: The adjusted script tag
access: private

string _postfixVersionToScript (string $str, string $version)

string $str: The script tag to append the version to
string $version: The version to append

_prepareVersionPostfix (line 342)

Grabs a stripped version of modx to prevent caching of JS after upgrades

return: The parsed version string
access: private

string _prepareVersionPostfix ()

Inherited Methods

Inherited From modResponse

modResponse::__construct()
modResponse::checkPreview()
modResponse::outputContent()
modResponse::sendRedirect()