model/modx/modmanagerresponse.class.php
- package
- modx
- Classes
- modManagerResponse
Description
modManagerResponse
\modManagerResponse
- Extends from
- \modResponse
- package
- modx
- Properties
- $action
- Methods
- _postfixVersionToScript
- _prepareVersionPostfix
- addLangTopic
- checkFormCustomizationRules
- getControllerFilename
- getLangTopics
- outputContent
- prepareNamespacePath
- registerBaseScripts
- registerCssJs
- setLangTopics
Description
Encapsulates an HTTP response from the MODX manager.
{@inheritdoc}
Properties
Methods
_postfixVersionToScript
_postfixVersionToScript(
string $str, string $version
)
:
stringAppends a version postfix to a script tag
Arguments
- $str
- string
The script tag to append the version to - $version
- string
The version to append
Output
- string
- The adjusted script tag
Details
- visibility
- private
- final
- false
- static
- false
- access
- private
_prepareVersionPostfix
_prepareVersionPostfix(
)
:
stringGrabs a stripped version of modx to prevent caching of JS after upgrades
Output
- string
- The parsed version string
Details
- visibility
- private
- final
- false
- static
- false
- access
- private
addLangTopic
addLangTopic(
string $topic
)
:
booleanAdds a lexicon topic to this page's language topics to load. Will load the topic as well.
Arguments
- $topic
- string
The topic to load, in standard namespace:topic format
Output
- boolean
- True if successful
Details
- visibility
- public
- final
- false
- static
- false
checkFormCustomizationRules
checkFormCustomizationRules(
\xPDOObject $obj
=
null, $forParent
=
false
)
:
Checks Form Customization rules for an object.
Arguments
- $obj
- \xPDOObject
If passed, will validate against for rules with constraints. - $forParent
Details
- visibility
- public
- final
- false
- static
- false
getControllerFilename
getControllerFilename(
string $f
)
:
mixedGets the parsed controller filename and checks for its existence.
Arguments
- $f
- string
The filename to parse.
Output
- mixed
- The parsed filename, or boolean false if invalid.
Details
- visibility
- protected
- final
- false
- static
- false
- access
- protected
getLangTopics
getLangTopics(
)
:
booleanAdds a lexicon topic to this page's language topics to load
Output
- boolean
- True if successful
Details
- visibility
- public
- final
- false
- static
- false
outputContent
outputContent(
array $options
=
array
)
:
Overrides modResponse::outputContent to provide mgr-context specific response.
{@inheritdoc}
Arguments
- $options
- array
Various options that can be set.
Details
- visibility
- public
- final
- false
- static
- false
prepareNamespacePath
prepareNamespacePath(
$controller, $theme
=
default
)
:
stringPrepares the Namespace Path for usage
Arguments
- $controller
- $theme
Output
- string
- The formatted Namespace path
Details
- visibility
- protected
- final
- false
- static
- false
- access
- protected
registerBaseScripts
registerBaseScripts(
$loadLayout
=
true
)
:
Registers the core and base JS scripts
Arguments
- $loadLayout
Details
- visibility
- public
- final
- false
- static
- false
- access
- public
registerCssJs
registerCssJs(
)
:
Registers CSS/JS to manager interface
Details
- visibility
- public
- final
- false
- static
- false
setLangTopics
setLangTopics(
array $topics
=
array
)
:
booleanSets the language topics for this page
Arguments
- $topics
- array
The array of topics to set
Output
- boolean
- True if successful
Details
- visibility
- public
- final
- false
- static
- false