manager/controllers/default/resource/update.class.php
- Package
- modx
- Subpackage
- manager.controllers
\DocumentUpdateManagerController
Loads the update resource page
Properties
$canCreate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canCreate
- Inherited_from
- \ResourceUpdateManagerController::$$canCreate
$canDelete= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDelete
- Inherited_from
- \ResourceUpdateManagerController::$$canDelete
$canDuplicate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDuplicate
- Inherited_from
- \ResourceUpdateManagerController::$$canDuplicate
$canEdit= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canEdit
- Inherited_from
- \ResourceUpdateManagerController::$$canEdit
$canPublish= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canPublish
- Inherited_from
- \ResourceUpdateManagerController::$$canPublish
$canSave= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canSave
- Inherited_from
- \ResourceUpdateManagerController::$$canSave
array
$config= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$config
- Inherited_from
- \ResourceManagerController::$$config
- Inherited_from
- \ResourceUpdateManagerController::$$config
string
$content= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$content
- Inherited_from
- \ResourceManagerController::$$content
- Inherited_from
- \ResourceUpdateManagerController::$$content
\modContext
$context= ''
- Type
- \modContext
- Inherited_from
- \ResourceManagerController::$$context
- Inherited_from
- \ResourceUpdateManagerController::$$context
array
$controllersPaths= ''
- Type
- array
- Inherited_from
- \modManagerController::$$controllersPaths
- Inherited_from
- \ResourceManagerController::$$controllersPaths
- Inherited_from
- \ResourceUpdateManagerController::$$controllersPaths
$ctx= ''web''
'web'
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$ctx
- Inherited_from
- \ResourceUpdateManagerController::$$ctx
\modMediaSource
$defaultSource= ''
- Type
- \modMediaSource
- Inherited_from
- \modManagerController::$$defaultSource
- Inherited_from
- \ResourceManagerController::$$defaultSource
- Inherited_from
- \ResourceUpdateManagerController::$$defaultSource
string
$failureMessage= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$failureMessage
- Inherited_from
- \ResourceManagerController::$$failureMessage
- Inherited_from
- \ResourceUpdateManagerController::$$failureMessage
array
$head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'
array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())
Details- Type
- array
- Inherited_from
- \modManagerController::$$head
- Inherited_from
- \ResourceManagerController::$$head
- Inherited_from
- \ResourceUpdateManagerController::$$head
bool
$isFailure= 'false'
false
Details- Type
- bool
- Inherited_from
- \modManagerController::$$isFailure
- Inherited_from
- \ResourceManagerController::$$isFailure
- Inherited_from
- \ResourceUpdateManagerController::$$isFailure
bool
$loadBaseJavascript= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadBaseJavascript
- Inherited_from
- \ResourceManagerController::$$loadBaseJavascript
- Inherited_from
- \ResourceUpdateManagerController::$$loadBaseJavascript
bool
$loadFooter= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadFooter
- Inherited_from
- \ResourceManagerController::$$loadFooter
- Inherited_from
- \ResourceUpdateManagerController::$$loadFooter
bool
$loadHeader= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadHeader
- Inherited_from
- \ResourceManagerController::$$loadHeader
- Inherited_from
- \ResourceUpdateManagerController::$$loadHeader
boolean
$locked= 'false'
false
Details- Type
- boolean
- Inherited_from
- \ResourceUpdateManagerController::$$locked
string
$lockedText= ''''
''
Details- Type
- string
- Inherited_from
- \ResourceUpdateManagerController::$$lockedText
\modX
$modx= ''
- Type
- \modX
- Inherited_from
- \modManagerController::$$modx
- Inherited_from
- \ResourceManagerController::$$modx
- Inherited_from
- \ResourceUpdateManagerController::$$modx
$onDocFormRender= ''''
''
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$onDocFormRender
- Inherited_from
- \ResourceUpdateManagerController::$$onDocFormRender
\modResource
$parent= ''
- Type
- \modResource
- Inherited_from
- \ResourceManagerController::$$parent
- Inherited_from
- \ResourceUpdateManagerController::$$parent
array
$placeholders= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$placeholders
- Inherited_from
- \ResourceManagerController::$$placeholders
- Inherited_from
- \ResourceUpdateManagerController::$$placeholders
string
$previewUrl= ''''
''
Details- Type
- string
- Inherited_from
- \ResourceUpdateManagerController::$$previewUrl
\modRegister
$reg= ''
- Type
- \modRegister
- Inherited_from
- \ResourceManagerController::$$reg
- Inherited_from
- \ResourceUpdateManagerController::$$reg
\modResource
$resource= ''
- Type
- \modResource
- Inherited_from
- \ResourceUpdateManagerController::$$resource
$resourceArray= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$resourceArray
- Inherited_from
- \ResourceUpdateManagerController::$$resourceArray
string
$resourceClass= ''modDocument''
'modDocument'
Details- Type
- string
- Inherited_from
- \ResourceManagerController::$$resourceClass
- Inherited_from
- \ResourceUpdateManagerController::$$resourceClass
array
$rteFields= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$rteFields
- Inherited_from
- \ResourceUpdateManagerController::$$rteFields
string
$ruleOutput= 'array()'
array()
Details- Type
- string
- Inherited_from
- \modManagerController::$$ruleOutput
- Inherited_from
- \ResourceManagerController::$$ruleOutput
- Inherited_from
- \ResourceUpdateManagerController::$$ruleOutput
array
$scriptProperties= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$scriptProperties
- Inherited_from
- \ResourceManagerController::$$scriptProperties
- Inherited_from
- \ResourceUpdateManagerController::$$scriptProperties
array
$templatesPaths= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$templatesPaths
- Inherited_from
- \ResourceManagerController::$$templatesPaths
- Inherited_from
- \ResourceUpdateManagerController::$$templatesPaths
string
$theme= ''default''
'default'
Details- Type
- string
- Inherited_from
- \modManagerController::$$theme
- Inherited_from
- \ResourceManagerController::$$theme
- Inherited_from
- \ResourceUpdateManagerController::$$theme
string
$title= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$title
- Inherited_from
- \ResourceManagerController::$$title
- Inherited_from
- \ResourceUpdateManagerController::$$title
array
$tvCounts= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$tvCounts
- Inherited_from
- \ResourceUpdateManagerController::$$tvCounts
\modContext
$workingContext= ''
- Type
- \modContext
- Inherited_from
- \modManagerController::$$workingContext
- Inherited_from
- \ResourceManagerController::$$workingContext
- Inherited_from
- \ResourceUpdateManagerController::$$workingContext
Methods
__construct(
\modX $modx, array $config
=
array()
)
:
void
The constructor for the modManaagerController class.
Inherited from: \modManagerController::__construct()\ResourceManagerController::__construct()\ResourceUpdateManagerController::__construct()Name | Type | Description |
---|---|---|
$modx | \modX | A reference to the modX object. |
$config | array | A configuration array of options related to this controller's action object. |
_postfixVersionToScript(
string $str, string $version
)
:
string
Appends a version postfix to a script tag
Inherited from: \modManagerController::_postfixVersionToScript()\ResourceManagerController::_postfixVersionToScript()\ResourceUpdateManagerController::_postfixVersionToScript()Name | Type | Description |
---|---|---|
$str | string | The script tag to append the version to |
$version | string | The version to append |
Type | Description |
---|---|
string | The adjusted script tag |
- Access
- private
_prepareHead(
)
:
void
Prepare the set html/css/js to be added
Inherited from: \modManagerController::_prepareHead()\ResourceManagerController::_prepareHead()\ResourceUpdateManagerController::_prepareHead()_prepareVersionPostfix(
)
:
string
Grabs a stripped version of modx to prevent caching of JS after upgrades
Inherited from: \modManagerController::_prepareVersionPostfix()\ResourceManagerController::_prepareVersionPostfix()\ResourceUpdateManagerController::_prepareVersionPostfix()Type | Description |
---|---|
string | The parsed version string |
- Access
- private
addCss(
string $script
)
:
void
Add a external CSS file to the head of the page
Inherited from: \modManagerController::addCss()\ResourceManagerController::addCss()\ResourceUpdateManagerController::addCss()Name | Type | Description |
---|---|---|
$script | string |
addHtml(
string $script
)
:
void
Add a block of HTML to the head of the page
Inherited from: \modManagerController::addHtml()\ResourceManagerController::addHtml()\ResourceUpdateManagerController::addHtml()Name | Type | Description |
---|---|---|
$script | string |
addJavascript(
string $script
)
:
void
Add an external Javascript file to the head of the page
Inherited from: \modManagerController::addJavascript()\ResourceManagerController::addJavascript()\ResourceUpdateManagerController::addJavascript()Name | Type | Description |
---|---|---|
$script | string |
addLastJavascript(
string $script
)
:
void
Add an external Javascript file to the head of the page
Inherited from: \modManagerController::addLastJavascript()\ResourceManagerController::addLastJavascript()\ResourceUpdateManagerController::addLastJavascript()Name | Type | Description |
---|---|---|
$script | string |
addLexiconTopic(
string $topic
)
:
string
Adds a topic to the JS language array
Inherited from: \modManagerController::addLexiconTopic()\ResourceManagerController::addLexiconTopic()\ResourceUpdateManagerController::addLexiconTopic()Name | Type | Description |
---|---|---|
$topic | string |
Type | Description |
---|---|
string |
assignPlaceholders(
)
:
void
checkForLocks(
)
:
bool
Check for locks on the Resource
Inherited from: \ResourceUpdateManagerController::checkForLocks()Type | Description |
---|---|
bool |
checkFormCustomizationRules(
\xPDOObject $obj
=
null, bool $forParent
=
false
)
:
bool
Checks Form Customization rules for an object.
Inherited from: \modManagerController::checkFormCustomizationRules()\ResourceManagerController::checkFormCustomizationRules()\ResourceUpdateManagerController::checkFormCustomizationRules()Name | Type | Description |
---|---|---|
$obj | \xPDOObject | If passed, will validate against for rules with constraints. |
$forParent | bool |
Type | Description |
---|---|
bool |
checkPermissions(
)
:
bool
Check for any permissions or requirements to load page
Inherited from: \ResourceUpdateManagerController::checkPermissions()Type | Description |
---|---|
bool |
failure(
string $message
)
:
void
Set a failure on this controller. This will return the error message.
Inherited from: \modManagerController::failure()\ResourceManagerController::failure()\ResourceUpdateManagerController::failure()Name | Type | Description |
---|---|---|
$message | string |
fetchTemplate(
string $tpl
)
:
string
Fetch the template content
Inherited from: \modManagerController::fetchTemplate()\ResourceManagerController::fetchTemplate()\ResourceUpdateManagerController::fetchTemplate()Name | Type | Description |
---|---|---|
$tpl | string | The path to the template |
Type | Description |
---|---|
string | The output of the template |
fireOnRenderEvent(
)
:
string
Fire any render events
Inherited from: \ResourceManagerController::fireOnRenderEvent()\ResourceUpdateManagerController::fireOnRenderEvent()Type | Description |
---|---|
string |
fireOnTVFormRender(
)
:
mixed
Fire the TV Form Render event
Inherited from: \ResourceManagerController::fireOnTVFormRender()\ResourceUpdateManagerController::fireOnTVFormRender()Type | Description |
---|---|
mixed |
firePostRenderEvents(
)
:
void
Can be used to fire events after all the CSS/JS is loaded for a page
Inherited from: \modManagerController::firePostRenderEvents()\ResourceManagerController::firePostRenderEvents()\ResourceUpdateManagerController::firePostRenderEvents()firePreRenderEvents(
)
:
array | bool | string
Fire any pre-render events
Inherited from: \ResourceManagerController::firePreRenderEvents()\ResourceUpdateManagerController::firePreRenderEvents()Type | Description |
---|---|
array | bool | string |
getControllersPaths(
bool $coreOnly
=
false
)
:
array
Get the path to this controller's directory. Override this to point to a custom directory.
Inherited from: \modManagerController::getControllersPaths()\ResourceManagerController::getControllersPaths()\ResourceUpdateManagerController::getControllersPaths()Name | Type | Description |
---|---|---|
$coreOnly | bool | Ensure that it grabs the path from the core namespace only. |
Type | Description |
---|---|
array |
getDefaultState(
)
:
array | mixed | string
Get the default state for the UI
Inherited from: \modManagerController::getDefaultState()\ResourceManagerController::getDefaultState()\ResourceUpdateManagerController::getDefaultState()Type | Description |
---|---|
array | mixed | string |
getFooter(
)
:
string
Get the page footer for the controller.
Inherited from: \modManagerController::getFooter()\ResourceManagerController::getFooter()\ResourceUpdateManagerController::getFooter()Type | Description |
---|---|
string |
getHeader(
)
:
string
Get the page header for the controller.
Inherited from: \modManagerController::getHeader()\ResourceManagerController::getHeader()\ResourceUpdateManagerController::getHeader()Type | Description |
---|---|
string |
getInstance(
\modX $modx, string $className, array $config
=
array()
)
:
\modManagerController
Return the appropriate Resource controller class based on the class_key request parameter
Inherited from: \ResourceManagerController::getInstance()\ResourceUpdateManagerController::getInstance()Name | Type | Description |
---|---|---|
$modx | \modX | A reference to the modX instance |
$className | string | The controller class name that is attempting to be loaded |
$config | array | An array of configuration options for the action |
Type | Description |
---|---|
\modManagerController | The proper controller class |
- Static
getLanguageTopics(
)
:
array
Specify the language topics to load
Inherited from: \ResourceManagerController::getLanguageTopics()\ResourceUpdateManagerController::getLanguageTopics()Type | Description |
---|---|
array |
getPlaceholder(
string $k, mixed $default
=
null
)
:
mixed
Get a specific placeholder set
Inherited from: \modManagerController::getPlaceholder()\ResourceManagerController::getPlaceholder()\ResourceUpdateManagerController::getPlaceholder()Name | Type | Description |
---|---|---|
$k | string | |
$default | mixed |
Type | Description |
---|---|
mixed |
getPlaceholders(
)
:
array
Get all the set placeholders
Inherited from: \modManagerController::getPlaceholders()\ResourceManagerController::getPlaceholders()\ResourceUpdateManagerController::getPlaceholders()Type | Description |
---|---|
array |
getPreviewUrl(
)
:
string
Get url for resource for preview window
Inherited from: \ResourceUpdateManagerController::getPreviewUrl()Type | Description |
---|---|
string |
getReloadData(
)
:
void
getResourceGroups(
)
:
void
getTemplateFile(
)
:
string
Return the location of the template file
Inherited from: \ResourceUpdateManagerController::getTemplateFile()Type | Description |
---|---|
string |
getTemplatesPaths(
bool $coreOnly
=
false
)
:
array | string
Get an array of possible paths to this controller's template's directory.
Inherited from: \modManagerController::getTemplatesPaths()\ResourceManagerController::getTemplatesPaths()\ResourceUpdateManagerController::getTemplatesPaths()Override this to point to a custom directory.
Name | Type | Description |
---|---|---|
$coreOnly | bool | Ensure that it grabs the path from the core namespace only. |
Type | Description |
---|---|
array | string |
initialize(
)
:
void
Can be used to provide custom methods prior to processing
Inherited from: \modManagerController::initialize()\ResourceManagerController::initialize()\ResourceUpdateManagerController::initialize()loadController(
$controller, bool $coreOnly
=
false
)
:
mixed | string
Load another manual controller file (such as header/footer)
Inherited from: \modManagerController::loadController()\ResourceManagerController::loadController()\ResourceUpdateManagerController::loadController()Name | Type | Description |
---|---|---|
$controller | ||
$coreOnly | bool |
Type | Description |
---|---|
mixed | string |
loadControllersPath(
)
:
array
Load an array of possible paths to this controller's directory. Only override this if you want to override default behavior; otherwise, overriding getControllersPath is preferred.
Inherited from: \modManagerController::loadControllersPath()\ResourceManagerController::loadControllersPath()\ResourceUpdateManagerController::loadControllersPath()Type | Description |
---|---|
array |
loadCustomCssJs(
)
:
void
Register custom CSS/JS for the page
Inherited from: \ResourceUpdateManagerController::loadCustomCssJs()loadRichTextEditor(
)
:
void
Initialize a RichText Editor, if set
Inherited from: \ResourceManagerController::loadRichTextEditor()\ResourceUpdateManagerController::loadRichTextEditor()loadTVs(
array $reloadData
=
array()
)
:
string
Load the TVs for the Resource
Inherited from: \ResourceManagerController::loadTVs()\ResourceUpdateManagerController::loadTVs()Name | Type | Description |
---|---|---|
$reloadData | array | resource data passed if reloading |
Type | Description |
---|---|
string | The TV editing form |
loadTemplatesPath(
)
:
string
Load the path to this controller's template's directory. Only override this if you want to override default behavior; otherwise, overriding getTemplatesPath is preferred.
Inherited from: \modManagerController::loadTemplatesPath()\ResourceManagerController::loadTemplatesPath()\ResourceUpdateManagerController::loadTemplatesPath()Type | Description |
---|---|
string |
loadWorkingContext(
)
:
\modContext | string
Load the working context for this controller.
Inherited from: \modManagerController::loadWorkingContext()\ResourceManagerController::loadWorkingContext()\ResourceUpdateManagerController::loadWorkingContext()Type | Description |
---|---|
\modContext | string |
prepareLanguage(
)
:
void
Prepares the language placeholders
Inherited from: \modManagerController::prepareLanguage()\ResourceManagerController::prepareLanguage()\ResourceUpdateManagerController::prepareLanguage()prepareResource(
)
:
void
Used to set values on the resource record sent to the template for derivative classes
Inherited from: \ResourceManagerController::prepareResource()\ResourceUpdateManagerController::prepareResource()process(
array $scriptProperties
=
array()
)
:
mixed
Process the controller, returning an array of placeholders to set.
Inherited from: \ResourceUpdateManagerController::process()Name | Type | Description |
---|---|---|
$scriptProperties | array | A array of REQUEST parameters. |
Type | Description |
---|---|
mixed | Either an error or output string, or an array of placeholders to set. |
registerBaseScripts(
)
:
void
Registers the core and base JS scripts
Inherited from: \modManagerController::registerBaseScripts()\ResourceManagerController::registerBaseScripts()\ResourceUpdateManagerController::registerBaseScripts()- Access
- public
registerCssJs(
)
:
void
Registers CSS/JS to manager interface
Inherited from: \modManagerController::registerCssJs()\ResourceManagerController::registerCssJs()\ResourceUpdateManagerController::registerCssJs()render(
)
:
string
Render the controller.
Inherited from: \modManagerController::render()\ResourceManagerController::render()\ResourceUpdateManagerController::render()Type | Description |
---|---|
string |
setContext(
)
:
\modContext
Get and set the context for this resource
Inherited from: \ResourceManagerController::setContext()\ResourceUpdateManagerController::setContext()Type | Description |
---|---|
\modContext |
setParent(
)
:
string
Get and set the parent for this resource
Inherited from: \ResourceManagerController::setParent()\ResourceUpdateManagerController::setParent()Type | Description |
---|---|
string | The pagetitle of the parent |
setPermissions(
)
:
void
Setup permissions for this page
Inherited from: \ResourceManagerController::setPermissions()\ResourceUpdateManagerController::setPermissions()setPlaceholder(
string $k, mixed $v
)
:
void
Set a placeholder for this controller's template
Inherited from: \modManagerController::setPlaceholder()\ResourceManagerController::setPlaceholder()\ResourceUpdateManagerController::setPlaceholder()Name | Type | Description |
---|---|---|
$k | string | The key of the placeholder |
$v | mixed | The value of the placeholder |
setPlaceholders(
array $keys
)
:
void
Set an array of placeholders
Inherited from: \modManagerController::setPlaceholders()\ResourceManagerController::setPlaceholders()\ResourceUpdateManagerController::setPlaceholders()Name | Type | Description |
---|---|---|
$keys | array |
setProperties(
array $properties
)
:
void
Sets the properties array for this controller
Inherited from: \modManagerController::setProperties()\ResourceManagerController::setProperties()\ResourceUpdateManagerController::setProperties()Name | Type | Description |
---|---|---|
$properties | array |
setProperty(
string $key, mixed $value
)
:
void
Set a property for this controller
Inherited from: \modManagerController::setProperty()\ResourceManagerController::setProperty()\ResourceUpdateManagerController::setProperty()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
setResourceToken(
)
:
void
Set token for validating a request
Inherited from: \ResourceManagerController::setResourceToken()\ResourceUpdateManagerController::setResourceToken()setTemplatePaths(
array $paths
)
:
void
Set the possible template paths for this controller
Inherited from: \modManagerController::setTemplatePaths()\ResourceManagerController::setTemplatePaths()\ResourceUpdateManagerController::setTemplatePaths()Name | Type | Description |
---|---|---|
$paths | array |
\ResourceUpdateManagerController
Loads the update resource page
- Parent(s)
- \ResourceManagerController < \modManagerController
- Children
- \WebLinkUpdateManagerController
- \StaticResourceUpdateManagerController
- \DocumentUpdateManagerController
- \SymlinkUpdateManagerController
Properties
$canCreate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canCreate
$canDelete= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDelete
$canDuplicate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDuplicate
$canEdit= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canEdit
$canPublish= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canPublish
$canSave= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canSave
array
$config= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$config
- Inherited_from
- \ResourceManagerController::$$config
string
$content= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$content
- Inherited_from
- \ResourceManagerController::$$content
\modContext
$context= ''
- Type
- \modContext
- Inherited_from
- \ResourceManagerController::$$context
array
$controllersPaths= ''
- Type
- array
- Inherited_from
- \modManagerController::$$controllersPaths
- Inherited_from
- \ResourceManagerController::$$controllersPaths
$ctx= ''web''
'web'
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$ctx
\modMediaSource
$defaultSource= ''
- Type
- \modMediaSource
- Inherited_from
- \modManagerController::$$defaultSource
- Inherited_from
- \ResourceManagerController::$$defaultSource
string
$failureMessage= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$failureMessage
- Inherited_from
- \ResourceManagerController::$$failureMessage
array
$head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'
array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())
Details- Type
- array
- Inherited_from
- \modManagerController::$$head
- Inherited_from
- \ResourceManagerController::$$head
bool
$isFailure= 'false'
false
Details- Type
- bool
- Inherited_from
- \modManagerController::$$isFailure
- Inherited_from
- \ResourceManagerController::$$isFailure
bool
$loadBaseJavascript= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadBaseJavascript
- Inherited_from
- \ResourceManagerController::$$loadBaseJavascript
bool
$loadFooter= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadFooter
- Inherited_from
- \ResourceManagerController::$$loadFooter
bool
$loadHeader= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadHeader
- Inherited_from
- \ResourceManagerController::$$loadHeader
boolean
$locked= 'false'
false
Details- Type
- boolean
string
$lockedText= ''''
''
Details- Type
- string
\modX
$modx= ''
- Type
- \modX
- Inherited_from
- \modManagerController::$$modx
- Inherited_from
- \ResourceManagerController::$$modx
$onDocFormRender= ''''
''
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$onDocFormRender
\modResource
$parent= ''
- Type
- \modResource
- Inherited_from
- \ResourceManagerController::$$parent
array
$placeholders= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$placeholders
- Inherited_from
- \ResourceManagerController::$$placeholders
string
$previewUrl= ''''
''
Details- Type
- string
\modRegister
$reg= ''
- Type
- \modRegister
- Inherited_from
- \ResourceManagerController::$$reg
$resourceArray= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$resourceArray
string
$resourceClass= ''modDocument''
'modDocument'
Details- Type
- string
- Inherited_from
- \ResourceManagerController::$$resourceClass
array
$rteFields= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$rteFields
string
$ruleOutput= 'array()'
array()
Details- Type
- string
- Inherited_from
- \modManagerController::$$ruleOutput
- Inherited_from
- \ResourceManagerController::$$ruleOutput
array
$scriptProperties= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$scriptProperties
- Inherited_from
- \ResourceManagerController::$$scriptProperties
array
$templatesPaths= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$templatesPaths
- Inherited_from
- \ResourceManagerController::$$templatesPaths
string
$theme= ''default''
'default'
Details- Type
- string
- Inherited_from
- \modManagerController::$$theme
- Inherited_from
- \ResourceManagerController::$$theme
string
$title= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$title
- Inherited_from
- \ResourceManagerController::$$title
array
$tvCounts= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$tvCounts
\modContext
$workingContext= ''
- Type
- \modContext
- Inherited_from
- \modManagerController::$$workingContext
- Inherited_from
- \ResourceManagerController::$$workingContext
Methods
__construct(
\modX $modx, array $config
=
array()
)
:
void
The constructor for the modManaagerController class.
Inherited from: \modManagerController::__construct()\ResourceManagerController::__construct()Name | Type | Description |
---|---|---|
$modx | \modX | A reference to the modX object. |
$config | array | A configuration array of options related to this controller's action object. |
_postfixVersionToScript(
string $str, string $version
)
:
string
Appends a version postfix to a script tag
Inherited from: \modManagerController::_postfixVersionToScript()\ResourceManagerController::_postfixVersionToScript()Name | Type | Description |
---|---|---|
$str | string | The script tag to append the version to |
$version | string | The version to append |
Type | Description |
---|---|
string | The adjusted script tag |
- Access
- private
_prepareHead(
)
:
void
Prepare the set html/css/js to be added
Inherited from: \modManagerController::_prepareHead()\ResourceManagerController::_prepareHead()_prepareVersionPostfix(
)
:
string
Grabs a stripped version of modx to prevent caching of JS after upgrades
Inherited from: \modManagerController::_prepareVersionPostfix()\ResourceManagerController::_prepareVersionPostfix()Type | Description |
---|---|
string | The parsed version string |
- Access
- private
addCss(
string $script
)
:
void
Add a external CSS file to the head of the page
Inherited from: \modManagerController::addCss()\ResourceManagerController::addCss()Name | Type | Description |
---|---|---|
$script | string |
addHtml(
string $script
)
:
void
Add a block of HTML to the head of the page
Inherited from: \modManagerController::addHtml()\ResourceManagerController::addHtml()Name | Type | Description |
---|---|---|
$script | string |
addJavascript(
string $script
)
:
void
Add an external Javascript file to the head of the page
Inherited from: \modManagerController::addJavascript()\ResourceManagerController::addJavascript()Name | Type | Description |
---|---|---|
$script | string |
addLastJavascript(
string $script
)
:
void
Add an external Javascript file to the head of the page
Inherited from: \modManagerController::addLastJavascript()\ResourceManagerController::addLastJavascript()Name | Type | Description |
---|---|---|
$script | string |
addLexiconTopic(
string $topic
)
:
string
Adds a topic to the JS language array
Inherited from: \modManagerController::addLexiconTopic()\ResourceManagerController::addLexiconTopic()Name | Type | Description |
---|---|---|
$topic | string |
Type | Description |
---|---|
string |
assignPlaceholders(
)
:
void
checkFormCustomizationRules(
\xPDOObject $obj
=
null, bool $forParent
=
false
)
:
bool
Checks Form Customization rules for an object.
Inherited from: \modManagerController::checkFormCustomizationRules()\ResourceManagerController::checkFormCustomizationRules()Name | Type | Description |
---|---|---|
$obj | \xPDOObject | If passed, will validate against for rules with constraints. |
$forParent | bool |
Type | Description |
---|---|
bool |
checkPermissions(
)
:
bool
Check for any permissions or requirements to load page
Type | Description |
---|---|
bool |
failure(
string $message
)
:
void
Set a failure on this controller. This will return the error message.
Inherited from: \modManagerController::failure()\ResourceManagerController::failure()Name | Type | Description |
---|---|---|
$message | string |
fetchTemplate(
string $tpl
)
:
string
Fetch the template content
Inherited from: \modManagerController::fetchTemplate()\ResourceManagerController::fetchTemplate()Name | Type | Description |
---|---|---|
$tpl | string | The path to the template |
Type | Description |
---|---|
string | The output of the template |
fireOnTVFormRender(
)
:
mixed
Fire the TV Form Render event
Inherited from: \ResourceManagerController::fireOnTVFormRender()Type | Description |
---|---|
mixed |
firePostRenderEvents(
)
:
void
Can be used to fire events after all the CSS/JS is loaded for a page
Inherited from: \modManagerController::firePostRenderEvents()\ResourceManagerController::firePostRenderEvents()firePreRenderEvents(
)
:
array | bool | string
Fire any pre-render events
Inherited from: \ResourceManagerController::firePreRenderEvents()Type | Description |
---|---|
array | bool | string |
getControllersPaths(
bool $coreOnly
=
false
)
:
array
Get the path to this controller's directory. Override this to point to a custom directory.
Inherited from: \modManagerController::getControllersPaths()\ResourceManagerController::getControllersPaths()Name | Type | Description |
---|---|---|
$coreOnly | bool | Ensure that it grabs the path from the core namespace only. |
Type | Description |
---|---|
array |
getDefaultState(
)
:
array | mixed | string
Get the default state for the UI
Inherited from: \modManagerController::getDefaultState()\ResourceManagerController::getDefaultState()Type | Description |
---|---|
array | mixed | string |
getFooter(
)
:
string
Get the page footer for the controller.
Inherited from: \modManagerController::getFooter()\ResourceManagerController::getFooter()Type | Description |
---|---|
string |
getHeader(
)
:
string
Get the page header for the controller.
Inherited from: \modManagerController::getHeader()\ResourceManagerController::getHeader()Type | Description |
---|---|
string |
getInstance(
\modX $modx, string $className, array $config
=
array()
)
:
\modManagerController
Return the appropriate Resource controller class based on the class_key request parameter
Inherited from: \ResourceManagerController::getInstance()Name | Type | Description |
---|---|---|
$modx | \modX | A reference to the modX instance |
$className | string | The controller class name that is attempting to be loaded |
$config | array | An array of configuration options for the action |
Type | Description |
---|---|
\modManagerController | The proper controller class |
- Static
getLanguageTopics(
)
:
array
Specify the language topics to load
Inherited from: \ResourceManagerController::getLanguageTopics()Type | Description |
---|---|
array |
getPlaceholder(
string $k, mixed $default
=
null
)
:
mixed
Get a specific placeholder set
Inherited from: \modManagerController::getPlaceholder()\ResourceManagerController::getPlaceholder()Name | Type | Description |
---|---|---|
$k | string | |
$default | mixed |
Type | Description |
---|---|
mixed |
getPlaceholders(
)
:
array
Get all the set placeholders
Inherited from: \modManagerController::getPlaceholders()\ResourceManagerController::getPlaceholders()Type | Description |
---|---|
array |
getResourceGroups(
)
:
void
getTemplatesPaths(
bool $coreOnly
=
false
)
:
array | string
Get an array of possible paths to this controller's template's directory.
Inherited from: \modManagerController::getTemplatesPaths()\ResourceManagerController::getTemplatesPaths()Override this to point to a custom directory.
Name | Type | Description |
---|---|---|
$coreOnly | bool | Ensure that it grabs the path from the core namespace only. |
Type | Description |
---|---|
array | string |
initialize(
)
:
void
Can be used to provide custom methods prior to processing
Inherited from: \modManagerController::initialize()\ResourceManagerController::initialize()loadController(
$controller, bool $coreOnly
=
false
)
:
mixed | string
Load another manual controller file (such as header/footer)
Inherited from: \modManagerController::loadController()\ResourceManagerController::loadController()Name | Type | Description |
---|---|---|
$controller | ||
$coreOnly | bool |
Type | Description |
---|---|
mixed | string |
loadControllersPath(
)
:
array
Load an array of possible paths to this controller's directory. Only override this if you want to override default behavior; otherwise, overriding getControllersPath is preferred.
Inherited from: \modManagerController::loadControllersPath()\ResourceManagerController::loadControllersPath()Type | Description |
---|---|
array |
loadRichTextEditor(
)
:
void
Initialize a RichText Editor, if set
Inherited from: \ResourceManagerController::loadRichTextEditor()loadTVs(
array $reloadData
=
array()
)
:
string
Name | Type | Description |
---|---|---|
$reloadData | array | resource data passed if reloading |
Type | Description |
---|---|
string | The TV editing form |
loadTemplatesPath(
)
:
string
Load the path to this controller's template's directory. Only override this if you want to override default behavior; otherwise, overriding getTemplatesPath is preferred.
Inherited from: \modManagerController::loadTemplatesPath()\ResourceManagerController::loadTemplatesPath()Type | Description |
---|---|
string |
loadWorkingContext(
)
:
\modContext | string
Load the working context for this controller.
Inherited from: \modManagerController::loadWorkingContext()\ResourceManagerController::loadWorkingContext()Type | Description |
---|---|
\modContext | string |
prepareLanguage(
)
:
void
Prepares the language placeholders
Inherited from: \modManagerController::prepareLanguage()\ResourceManagerController::prepareLanguage()prepareResource(
)
:
void
Used to set values on the resource record sent to the template for derivative classes
Inherited from: \ResourceManagerController::prepareResource()process(
array $scriptProperties
=
array()
)
:
mixed
Process the controller, returning an array of placeholders to set.
Name | Type | Description |
---|---|---|
$scriptProperties | array | A array of REQUEST parameters. |
Type | Description |
---|---|
mixed | Either an error or output string, or an array of placeholders to set. |
registerBaseScripts(
)
:
void
Registers the core and base JS scripts
Inherited from: \modManagerController::registerBaseScripts()\ResourceManagerController::registerBaseScripts()- Access
- public
registerCssJs(
)
:
void
Registers CSS/JS to manager interface
Inherited from: \modManagerController::registerCssJs()\ResourceManagerController::registerCssJs()render(
)
:
string
Render the controller.
Inherited from: \modManagerController::render()\ResourceManagerController::render()Type | Description |
---|---|
string |
setContext(
)
:
\modContext
Get and set the context for this resource
Inherited from: \ResourceManagerController::setContext()Type | Description |
---|---|
\modContext |
setParent(
)
:
string
Get and set the parent for this resource
Inherited from: \ResourceManagerController::setParent()Type | Description |
---|---|
string | The pagetitle of the parent |
setPermissions(
)
:
void
Setup permissions for this page
Inherited from: \ResourceManagerController::setPermissions()setPlaceholder(
string $k, mixed $v
)
:
void
Set a placeholder for this controller's template
Inherited from: \modManagerController::setPlaceholder()\ResourceManagerController::setPlaceholder()Name | Type | Description |
---|---|---|
$k | string | The key of the placeholder |
$v | mixed | The value of the placeholder |
setPlaceholders(
array $keys
)
:
void
Set an array of placeholders
Inherited from: \modManagerController::setPlaceholders()\ResourceManagerController::setPlaceholders()Name | Type | Description |
---|---|---|
$keys | array |
setProperties(
array $properties
)
:
void
Sets the properties array for this controller
Inherited from: \modManagerController::setProperties()\ResourceManagerController::setProperties()Name | Type | Description |
---|---|---|
$properties | array |
setProperty(
string $key, mixed $value
)
:
void
Set a property for this controller
Inherited from: \modManagerController::setProperty()\ResourceManagerController::setProperty()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
setResourceToken(
)
:
void
Set token for validating a request
Inherited from: \ResourceManagerController::setResourceToken()setTemplatePaths(
array $paths
)
:
void
Set the possible template paths for this controller
Inherited from: \modManagerController::setTemplatePaths()\ResourceManagerController::setTemplatePaths()Name | Type | Description |
---|---|---|
$paths | array |