manager/controllers/default/resource/update.class.php

Show: inherited
Table of Contents

Package
modx  
Subpackage
manager.controllers  

\DocumentUpdateManagerController

Package:

Loads the update resource page

Parent(s)
\ResourceUpdateManagerController < \ResourceManagerController < \modManagerController

Properties

Propertypublic  $canCreate= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canCreate  
Inherited_from
\ResourceUpdateManagerController::$$canCreate  
Propertypublic  $canDelete= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canDelete  
Inherited_from
\ResourceUpdateManagerController::$$canDelete  
Propertypublic  $canDuplicate= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canDuplicate  
Inherited_from
\ResourceUpdateManagerController::$$canDuplicate  
Propertypublic  $canEdit= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canEdit  
Inherited_from
\ResourceUpdateManagerController::$$canEdit  
Propertypublic  $canPublish= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canPublish  
Inherited_from
\ResourceUpdateManagerController::$$canPublish  
Propertypublic  $canSave= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canSave  
Inherited_from
\ResourceUpdateManagerController::$$canSave  
Propertypublicarray  $config= 'array()'
inheritedA configuration array of options related to this controller's action object.

Inherited from: \modManagerController::$$config\ResourceManagerController::$$config\ResourceUpdateManagerController::$$config
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$config  
Inherited_from
\ResourceManagerController::$$config  
Inherited_from
\ResourceUpdateManagerController::$$config  
Propertypublicstring  $content= ''''
Default value''Details
Type
string
Inherited_from
\modManagerController::$$content  
Inherited_from
\ResourceManagerController::$$content  
Inherited_from
\ResourceUpdateManagerController::$$content  
Propertypublicarray  $controllersPaths= ''
Propertypublic  $ctx= ''web''
Default value'web'Details
Type
n/a
Inherited_from
\ResourceManagerController::$$ctx  
Inherited_from
\ResourceUpdateManagerController::$$ctx  
Propertyprotectedstring  $failureMessage= ''''
Default value''Details
Type
string
Inherited_from
\modManagerController::$$failureMessage  
Inherited_from
\ResourceManagerController::$$failureMessage  
Inherited_from
\ResourceUpdateManagerController::$$failureMessage  
Propertypublicarray  $head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'
inheritedAn array of css/js/html to load into the HEAD of the page

Inherited from: \modManagerController::$$head\ResourceManagerController::$$head\ResourceUpdateManagerController::$$head
Default valuearray('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())Details
Type
array
Inherited_from
\modManagerController::$$head  
Inherited_from
\ResourceManagerController::$$head  
Inherited_from
\ResourceUpdateManagerController::$$head  
Propertyprotectedbool  $isFailure= 'false'
inheritedWhether or not a failure message was sent by this controller.

Inherited from: \modManagerController::$$isFailure\ResourceManagerController::$$isFailure\ResourceUpdateManagerController::$$isFailure
Default valuefalseDetails
Type
bool
Inherited_from
\modManagerController::$$isFailure  
Inherited_from
\ResourceManagerController::$$isFailure  
Inherited_from
\ResourceUpdateManagerController::$$isFailure  
Propertypublicbool  $loadBaseJavascript= 'true'
Propertypublicbool  $loadFooter= 'true'
Default valuetrueDetails
Type
bool
Inherited_from
\modManagerController::$$loadFooter  
Inherited_from
\ResourceManagerController::$$loadFooter  
Inherited_from
\ResourceUpdateManagerController::$$loadFooter  
Propertypublicbool  $loadHeader= 'true'
Default valuetrueDetails
Type
bool
Inherited_from
\modManagerController::$$loadHeader  
Inherited_from
\ResourceManagerController::$$loadHeader  
Inherited_from
\ResourceUpdateManagerController::$$loadHeader  
Propertypublicboolean  $locked= 'false'
inherited

Whether or not this Resource is locked for editingInherited from: \ResourceUpdateManagerController::$$locked
Default valuefalseDetails
Type
boolean
Inherited_from
\ResourceUpdateManagerController::$$locked  
Propertypublicstring  $lockedText= ''''
inherited

If the Resource is locked, the text on the locked button to showInherited from: \ResourceUpdateManagerController::$$lockedText
Default value''Details
Type
string
Inherited_from
\ResourceUpdateManagerController::$$lockedText  
Propertypublic\modX  $modx= ''
Details
Type
\modX
Inherited_from
\modManagerController::$$modx  
Inherited_from
\ResourceManagerController::$$modx  
Inherited_from
\ResourceUpdateManagerController::$$modx  
Propertypublicarray  $placeholders= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$placeholders  
Inherited_from
\ResourceManagerController::$$placeholders  
Inherited_from
\ResourceUpdateManagerController::$$placeholders  
Propertypublicstring  $previewUrl= ''''
inherited

The URL of the resource on the front-endInherited from: \ResourceUpdateManagerController::$$previewUrl
Default value''Details
Type
string
Inherited_from
\ResourceUpdateManagerController::$$previewUrl  
Propertyprotected\modRegister  $reg= ''
Propertypublic\modResource  $resource= ''
Propertypublic  $resourceArray= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\ResourceManagerController::$$resourceArray  
Inherited_from
\ResourceUpdateManagerController::$$resourceArray  
Propertypublicstring  $resourceClass= ''modDocument''
Default value'modDocument'Details
Type
string
Inherited_from
\ResourceManagerController::$$resourceClass  
Inherited_from
\ResourceUpdateManagerController::$$resourceClass  
Propertypublicarray  $rteFields= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\ResourceManagerController::$$rteFields  
Inherited_from
\ResourceUpdateManagerController::$$rteFields  
Propertyprotectedstring  $ruleOutput= 'array()'
Default valuearray()Details
Type
string
Inherited_from
\modManagerController::$$ruleOutput  
Inherited_from
\ResourceManagerController::$$ruleOutput  
Inherited_from
\ResourceUpdateManagerController::$$ruleOutput  
Propertypublicarray  $scriptProperties= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$scriptProperties  
Inherited_from
\ResourceManagerController::$$scriptProperties  
Inherited_from
\ResourceUpdateManagerController::$$scriptProperties  
Propertypublicarray  $templatesPaths= 'array()'
inheritedAn array of possible paths to this controller's templates directory.

Inherited from: \modManagerController::$$templatesPaths\ResourceManagerController::$$templatesPaths\ResourceUpdateManagerController::$$templatesPaths
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$templatesPaths  
Inherited_from
\ResourceManagerController::$$templatesPaths  
Inherited_from
\ResourceUpdateManagerController::$$templatesPaths  
Propertyprotectedstring  $theme= ''default''
Default value'default'Details
Type
string
Inherited_from
\modManagerController::$$theme  
Inherited_from
\ResourceManagerController::$$theme  
Inherited_from
\ResourceUpdateManagerController::$$theme  
Propertyprotectedstring  $title= ''''
Default value''Details
Type
string
Inherited_from
\modManagerController::$$title  
Inherited_from
\ResourceManagerController::$$title  
Inherited_from
\ResourceUpdateManagerController::$$title  
Propertypublicarray  $tvCounts= 'array()'
Default valuearray()Details
Type
array
Inherited_from
\ResourceManagerController::$$tvCounts  
Inherited_from
\ResourceUpdateManagerController::$$tvCounts  

Methods

methodpublic__construct( \modX $modx, array $config = array() ) : void
Parameters
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.

methodprivate_postfixVersionToScript( string $str, string $version ) : string
Parameters
Name Type Description
$str string

The script tag to append the version to

$version string

The version to append

Returns
Type Description
string The adjusted script tag
Details
Access
private  
methodprivate_prepareHead( ) : void
methodprivate_prepareVersionPostfix( ) : string
Returns
Type Description
string The parsed version string
Details
Access
private  
methodpublicaddCss( string $script ) : void
inherited

Add a external CSS file to the head of the page

Inherited from: \modManagerController::addCss()\ResourceManagerController::addCss()\ResourceUpdateManagerController::addCss()
Parameters
Name Type Description
$script string
methodpublicaddHtml( string $script ) : void
Parameters
Name Type Description
$script string
methodpublicaddJavascript( string $script ) : void
Parameters
Name Type Description
$script string
methodpublicaddLastJavascript( string $script ) : void
Parameters
Name Type Description
$script string
methodpublicaddLexiconTopic( string $topic ) : string
Parameters
Name Type Description
$topic string
Returns
Type Description
string
methodpubliccheckForLocks( ) : bool
inherited

Check for locks on the Resource

Inherited from: \ResourceUpdateManagerController::checkForLocks()
Returns
Type Description
bool
methodpubliccheckFormCustomizationRules( \xPDOObject $obj = null, bool $forParent = false ) : bool
Parameters
Name Type Description
$obj \xPDOObject

If passed, will validate against for rules with constraints.

$forParent bool
Returns
Type Description
bool
methodpubliccheckPermissions( ) : bool
inherited

Check for any permissions or requirements to load page

Inherited from: \ResourceUpdateManagerController::checkPermissions()
Returns
Type Description
bool
methodpublicfailure( string $message ) : void
inherited

Set a failure on this controller. This will return the error message.

Inherited from: \modManagerController::failure()\ResourceManagerController::failure()\ResourceUpdateManagerController::failure()
Parameters
Name Type Description
$message string
methodpublicfetchTemplate( string $tpl ) : string
Parameters
Name Type Description
$tpl string

The path to the template

Returns
Type Description
string The output of the template
methodpublicfireOnRenderEvent( ) : string
Returns
Type Description
string
methodpublicfireOnTVFormRender( ) : mixed
Returns
Type Description
mixed
methodpublicfirePostRenderEvents( ) : void
methodpublicfirePreRenderEvents( ) : array | bool | string
Returns
Type Description
array | bool | string
methodpublicgetControllersPaths( bool $coreOnly = false ) : array
inherited

Get the path to this controller's directory. Override this to point to a custom directory.

Inherited from: \modManagerController::getControllersPaths()\ResourceManagerController::getControllersPaths()\ResourceUpdateManagerController::getControllersPaths()
Parameters
Name Type Description
$coreOnly bool

Ensure that it grabs the path from the core namespace only.

Returns
Type Description
array
methodpublicgetDefaultState( ) : array | mixed | string
Returns
Type Description
array | mixed | string
methodpublicgetFooter( ) : string
Returns
Type Description
string
methodpublicgetHeader( ) : string
Returns
Type Description
string
methodpublicgetInstance( \modX $modx, string $className, array $config = array() ) : \modManagerController
staticinherited

Return the appropriate Resource controller class based on the class_key request parameter

Inherited from: \ResourceManagerController::getInstance()\ResourceUpdateManagerController::getInstance()
Parameters
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

Returns
Type Description
\modManagerController The proper controller class
Details
Static
 
methodpublicgetLanguageTopics( ) : array
Returns
Type Description
array
methodpublicgetPageTitle( ) : string
inherited

Return the pagetitle

Inherited from: \ResourceUpdateManagerController::getPageTitle()
Returns
Type Description
string
methodpublicgetPlaceholder( string $k, mixed $default = null ) : mixed
Parameters
Name Type Description
$k string
$default mixed
Returns
Type Description
mixed
methodpublicgetPlaceholders( ) : array
Returns
Type Description
array
methodpublicgetPreviewUrl( ) : string
inherited

Get url for resource for preview window

Inherited from: \ResourceUpdateManagerController::getPreviewUrl()
Returns
Type Description
string
methodpublicgetResource( ) : void
methodpublicgetTemplateFile( ) : string
inherited

Return the location of the template file

Inherited from: \ResourceUpdateManagerController::getTemplateFile()
Returns
Type Description
string
methodpublicgetTemplatesPaths( bool $coreOnly = false ) : array | string
inherited

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.

Parameters
Name Type Description
$coreOnly bool

Ensure that it grabs the path from the core namespace only.

Returns
Type Description
array | string
methodpublicinitialize( ) : void
inherited

Can be used to provide custom methods prior to processing

Inherited from: \modManagerController::initialize()\ResourceManagerController::initialize()\ResourceUpdateManagerController::initialize()
methodpublicloadController(  $controller, bool $coreOnly = false ) : mixed | string
Parameters
Name Type Description
$controller
$coreOnly bool
Returns
Type Description
mixed | string
methodpublicloadControllersPath( ) : array
inherited

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()
Returns
Type Description
array
methodpublicloadCustomCssJs( ) : void
inherited

Register custom CSS/JS for the page

Inherited from: \ResourceUpdateManagerController::loadCustomCssJs()
methodpublicloadRichTextEditor( ) : void
methodpublicloadTVs( array $reloadData = array() ) : string
inherited

Load the TVs for the Resource

Inherited from: \ResourceManagerController::loadTVs()\ResourceUpdateManagerController::loadTVs()
Parameters
Name Type Description
$reloadData array

resource data passed if reloading

Returns
Type Description
string The TV editing form
methodpublicloadTemplatesPath( ) : string
inherited

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()
Returns
Type Description
string
methodpublicloadWorkingContext( ) : \modContext | string
Returns
Type Description
\modContext | string
methodpublicprepareResource( ) : void
inherited

Used to set values on the resource record sent to the template for derivative classes

Inherited from: \ResourceManagerController::prepareResource()\ResourceUpdateManagerController::prepareResource()
methodpublicprocess( array $scriptProperties = array() ) : mixed
inherited

Process the controller, returning an array of placeholders to set.

Inherited from: \ResourceUpdateManagerController::process()
Parameters
Name Type Description
$scriptProperties array

A array of REQUEST parameters.

Returns
Type Description
mixed Either an error or output string, or an array of placeholders to set.
methodpublicregisterBaseScripts( ) : void
Details
Access
public  
methodpublicregisterCssJs( ) : void
methodpublicrender( ) : string
Returns
Type Description
string
methodpublicsetContext( ) : \modContext
inherited

Get and set the context for this resource

Inherited from: \ResourceManagerController::setContext()\ResourceUpdateManagerController::setContext()
Returns
Type Description
\modContext
methodpublicsetParent( ) : string
inherited

Get and set the parent for this resource

Inherited from: \ResourceManagerController::setParent()\ResourceUpdateManagerController::setParent()
Returns
Type Description
string The pagetitle of the parent
methodpublicsetPermissions( ) : void
methodpublicsetPlaceholder( string $k, mixed $v ) : void
Parameters
Name Type Description
$k string

The key of the placeholder

$v mixed

The value of the placeholder

methodpublicsetPlaceholders( array $keys ) : void
Parameters
Name Type Description
$keys array
methodpublicsetProperties( array $properties ) : void
Parameters
Name Type Description
$properties array
methodpublicsetProperty( string $key, mixed $value ) : void
Parameters
Name Type Description
$key string
$value mixed
methodpublicsetResourceToken( ) : void
methodpublicsetTemplatePaths( array $paths ) : void
Parameters
Name Type Description
$paths array

\ResourceUpdateManagerController

Package: modx\manager\controllers

Loads the update resource page

Parent(s)
\ResourceManagerController < \modManagerController
Children
\WebLinkUpdateManagerController
\StaticResourceUpdateManagerController
\DocumentUpdateManagerController
\SymlinkUpdateManagerController

Properties

Propertypublic  $canCreate= 'true'
inheritedInherited from: \ResourceManagerController::$$canCreate
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canCreate  
Propertypublic  $canDelete= 'true'
inheritedInherited from: \ResourceManagerController::$$canDelete
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canDelete  
Propertypublic  $canDuplicate= 'true'
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canDuplicate  
Propertypublic  $canEdit= 'true'
inheritedInherited from: \ResourceManagerController::$$canEdit
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canEdit  
Propertypublic  $canPublish= 'true'
inheritedInherited from: \ResourceManagerController::$$canPublish
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canPublish  
Propertypublic  $canSave= 'true'
inheritedInherited from: \ResourceManagerController::$$canSave
Default valuetrueDetails
Type
n/a
Inherited_from
\ResourceManagerController::$$canSave  
Propertypublicarray  $config= 'array()'
inheritedA configuration array of options related to this controller's action object.

Inherited from: \modManagerController::$$config\ResourceManagerController::$$config
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$config  
Inherited_from
\ResourceManagerController::$$config  
Propertypublicstring  $content= ''''
inheritedThe current output content

Inherited from: \modManagerController::$$content\ResourceManagerController::$$content
Default value''Details
Type
string
Inherited_from
\modManagerController::$$content  
Inherited_from
\ResourceManagerController::$$content  
Propertypublic\modContext  $context= ''
inherited

Inherited from: \ResourceManagerController::$$context
Details
Type
\modContext
Inherited_from
\ResourceManagerController::$$context  
Propertypublicarray  $controllersPaths= ''
inheritedAn array of possible paths to this controller's directory.

Inherited from: \modManagerController::$$controllersPaths\ResourceManagerController::$$controllersPaths
Details
Type
array
Inherited_from
\modManagerController::$$controllersPaths  
Inherited_from
\ResourceManagerController::$$controllersPaths  
Propertypublic  $ctx= ''web''
inheritedInherited from: \ResourceManagerController::$$ctx
Default value'web'Details
Type
n/a
Inherited_from
\ResourceManagerController::$$ctx  
Propertypublic\modMediaSource  $defaultSource= ''
inheritedThe default media source for the user

Inherited from: \modManagerController::$$defaultSource\ResourceManagerController::$$defaultSource
Propertyprotectedstring  $failureMessage= ''''
inheritedThe failure message, if existent, for this controller.

Inherited from: \modManagerController::$$failureMessage\ResourceManagerController::$$failureMessage
Default value''Details
Type
string
Inherited_from
\modManagerController::$$failureMessage  
Inherited_from
\ResourceManagerController::$$failureMessage  
Propertypublicarray  $head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'
inheritedAn array of css/js/html to load into the HEAD of the page

Inherited from: \modManagerController::$$head\ResourceManagerController::$$head
Default valuearray('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())Details
Type
array
Inherited_from
\modManagerController::$$head  
Inherited_from
\ResourceManagerController::$$head  
Propertyprotectedbool  $isFailure= 'false'
inheritedWhether or not a failure message was sent by this controller.

Inherited from: \modManagerController::$$isFailure\ResourceManagerController::$$isFailure
Default valuefalseDetails
Type
bool
Inherited_from
\modManagerController::$$isFailure  
Inherited_from
\ResourceManagerController::$$isFailure  
Propertypublicbool  $loadBaseJavascript= 'true'
inheritedSet to false to prevent loading of the base MODExt JS classes.

Inherited from: \modManagerController::$$loadBaseJavascript\ResourceManagerController::$$loadBaseJavascript
Default valuetrueDetails
Type
bool
Inherited_from
\modManagerController::$$loadBaseJavascript  
Inherited_from
\ResourceManagerController::$$loadBaseJavascript  
Propertypublicbool  $loadFooter= 'true'
inheritedSet to false to prevent loading of the footer HTML.

Inherited from: \modManagerController::$$loadFooter\ResourceManagerController::$$loadFooter
Default valuetrueDetails
Type
bool
Inherited_from
\modManagerController::$$loadFooter  
Inherited_from
\ResourceManagerController::$$loadFooter  
Propertypublicbool  $loadHeader= 'true'
inheritedSet to false to prevent loading of the header HTML.

Inherited from: \modManagerController::$$loadHeader\ResourceManagerController::$$loadHeader
Default valuetrueDetails
Type
bool
Inherited_from
\modManagerController::$$loadHeader  
Inherited_from
\ResourceManagerController::$$loadHeader  
Propertypublicboolean  $locked= 'false'

Whether or not this Resource is locked for editing
Default valuefalseDetails
Type
boolean
Propertypublicstring  $lockedText= ''''

If the Resource is locked, the text on the locked button to show
Default value''Details
Type
string
Propertypublic\modX  $modx= ''
inheritedA reference to the modX object

Inherited from: \modManagerController::$$modx\ResourceManagerController::$$modx
Details
Type
\modX
Inherited_from
\modManagerController::$$modx  
Inherited_from
\ResourceManagerController::$$modx  
Propertypublic  $onDocFormRender= ''''
Default value''Details
Type
n/a
Inherited_from
\ResourceManagerController::$$onDocFormRender  
Propertypublic\modResource  $parent= ''
inherited

Inherited from: \ResourceManagerController::$$parent
Details
Type
\modResource
Inherited_from
\ResourceManagerController::$$parent  
Propertypublicarray  $placeholders= 'array()'
inheritedAn array of placeholders that are being set to the page

Inherited from: \modManagerController::$$placeholders\ResourceManagerController::$$placeholders
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$placeholders  
Inherited_from
\ResourceManagerController::$$placeholders  
Propertypublicstring  $previewUrl= ''''

The URL of the resource on the front-end
Default value''Details
Type
string
Propertyprotected\modRegister  $reg= ''
inherited

Inherited from: \ResourceManagerController::$$reg
Details
Type
\modRegister
Inherited_from
\ResourceManagerController::$$reg  
Propertypublic\modResource  $resource= ''

Details
Type
\modResource
Propertypublic  $resourceArray= 'array()'
Default valuearray()Details
Type
n/a
Inherited_from
\ResourceManagerController::$$resourceArray  
Propertypublicstring  $resourceClass= ''modDocument''
Default value'modDocument'Details
Type
string
Inherited_from
\ResourceManagerController::$$resourceClass  
Propertypublicarray  $rteFields= 'array()'
inherited

Inherited from: \ResourceManagerController::$$rteFields
Default valuearray()Details
Type
array
Inherited_from
\ResourceManagerController::$$rteFields  
Propertyprotectedstring  $ruleOutput= 'array()'
inheritedAny Form Customization rule output that was created.

Inherited from: \modManagerController::$$ruleOutput\ResourceManagerController::$$ruleOutput
Default valuearray()Details
Type
string
Inherited_from
\modManagerController::$$ruleOutput  
Inherited_from
\ResourceManagerController::$$ruleOutput  
Propertypublicarray  $scriptProperties= 'array()'
inheritedAn array of request parameters sent to the controller

Inherited from: \modManagerController::$$scriptProperties\ResourceManagerController::$$scriptProperties
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$scriptProperties  
Inherited_from
\ResourceManagerController::$$scriptProperties  
Propertypublicarray  $templatesPaths= 'array()'
inheritedAn array of possible paths to this controller's templates directory.

Inherited from: \modManagerController::$$templatesPaths\ResourceManagerController::$$templatesPaths
Default valuearray()Details
Type
array
Inherited_from
\modManagerController::$$templatesPaths  
Inherited_from
\ResourceManagerController::$$templatesPaths  
Propertyprotectedstring  $theme= ''default''
inheritedThe current manager theme.

Inherited from: \modManagerController::$$theme\ResourceManagerController::$$theme
Default value'default'Details
Type
string
Inherited_from
\modManagerController::$$theme  
Inherited_from
\ResourceManagerController::$$theme  
Propertyprotectedstring  $title= ''''
inheritedThe pagetitle for this controller.

Inherited from: \modManagerController::$$title\ResourceManagerController::$$title
Default value''Details
Type
string
Inherited_from
\modManagerController::$$title  
Inherited_from
\ResourceManagerController::$$title  
Propertypublicarray  $tvCounts= 'array()'
inherited

Inherited from: \ResourceManagerController::$$tvCounts
Default valuearray()Details
Type
array
Inherited_from
\ResourceManagerController::$$tvCounts  
Propertypublic\modContext  $workingContext= ''
inheritedThe current working context.

Inherited from: \modManagerController::$$workingContext\ResourceManagerController::$$workingContext

Methods

methodpublic__construct( \modX $modx, array $config = array() ) : void
inherited

The constructor for the modManaagerController class.

Inherited from: \modManagerController::__construct()\ResourceManagerController::__construct()
Parameters
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.

methodprivate_postfixVersionToScript( string $str, string $version ) : string
inherited

Appends a version postfix to a script tag

Inherited from: \modManagerController::_postfixVersionToScript()\ResourceManagerController::_postfixVersionToScript()
Parameters
Name Type Description
$str string

The script tag to append the version to

$version string

The version to append

Returns
Type Description
string The adjusted script tag
Details
Access
private  
methodprivate_prepareHead( ) : void
inherited

Prepare the set html/css/js to be added

Inherited from: \modManagerController::_prepareHead()\ResourceManagerController::_prepareHead()
methodprivate_prepareVersionPostfix( ) : string
inherited

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

Inherited from: \modManagerController::_prepareVersionPostfix()\ResourceManagerController::_prepareVersionPostfix()
Returns
Type Description
string The parsed version string
Details
Access
private  
methodpublicaddCss( string $script ) : void
inherited

Add a external CSS file to the head of the page

Inherited from: \modManagerController::addCss()\ResourceManagerController::addCss()
Parameters
Name Type Description
$script string
methodpublicaddHtml( string $script ) : void
inherited

Add a block of HTML to the head of the page

Inherited from: \modManagerController::addHtml()\ResourceManagerController::addHtml()
Parameters
Name Type Description
$script string
methodpublicaddJavascript( string $script ) : void
inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addJavascript()\ResourceManagerController::addJavascript()
Parameters
Name Type Description
$script string
methodpublicaddLastJavascript( string $script ) : void
inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addLastJavascript()\ResourceManagerController::addLastJavascript()
Parameters
Name Type Description
$script string
methodpublicaddLexiconTopic( string $topic ) : string
inherited

Adds a topic to the JS language array

Inherited from: \modManagerController::addLexiconTopic()\ResourceManagerController::addLexiconTopic()
Parameters
Name Type Description
$topic string
Returns
Type Description
string
methodpubliccheckForLocks( ) : bool

Check for locks on the Resource

Returns
Type Description
bool
methodpubliccheckFormCustomizationRules( \xPDOObject $obj = null, bool $forParent = false ) : bool
inherited

Checks Form Customization rules for an object.

Inherited from: \modManagerController::checkFormCustomizationRules()\ResourceManagerController::checkFormCustomizationRules()
Parameters
Name Type Description
$obj \xPDOObject

If passed, will validate against for rules with constraints.

$forParent bool
Returns
Type Description
bool
methodpubliccheckPermissions( ) : bool

Check for any permissions or requirements to load page

Returns
Type Description
bool
methodpublicfailure( string $message ) : void
inherited

Set a failure on this controller. This will return the error message.

Inherited from: \modManagerController::failure()\ResourceManagerController::failure()
Parameters
Name Type Description
$message string
methodpublicfetchTemplate( string $tpl ) : string
inherited

Fetch the template content

Inherited from: \modManagerController::fetchTemplate()\ResourceManagerController::fetchTemplate()
Parameters
Name Type Description
$tpl string

The path to the template

Returns
Type Description
string The output of the template
methodpublicfireOnRenderEvent( ) : string
inherited

Fire any render events

Inherited from: \ResourceManagerController::fireOnRenderEvent()
Returns
Type Description
string
methodpublicfireOnTVFormRender( ) : mixed
inherited

Fire the TV Form Render event

Inherited from: \ResourceManagerController::fireOnTVFormRender()
Returns
Type Description
mixed
methodpublicfirePostRenderEvents( ) : void
inherited

Can be used to fire events after all the CSS/JS is loaded for a page

Inherited from: \modManagerController::firePostRenderEvents()\ResourceManagerController::firePostRenderEvents()
methodpublicfirePreRenderEvents( ) : array | bool | string
inherited

Fire any pre-render events

Inherited from: \ResourceManagerController::firePreRenderEvents()
Returns
Type Description
array | bool | string
methodpublicgetControllersPaths( bool $coreOnly = false ) : array
inherited

Get the path to this controller's directory. Override this to point to a custom directory.

Inherited from: \modManagerController::getControllersPaths()\ResourceManagerController::getControllersPaths()
Parameters
Name Type Description
$coreOnly bool

Ensure that it grabs the path from the core namespace only.

Returns
Type Description
array
methodpublicgetDefaultState( ) : array | mixed | string
inherited

Get the default state for the UI

Inherited from: \modManagerController::getDefaultState()\ResourceManagerController::getDefaultState()
Returns
Type Description
array | mixed | string
methodpublicgetFooter( ) : string
inherited

Get the page footer for the controller.

Inherited from: \modManagerController::getFooter()\ResourceManagerController::getFooter()
Returns
Type Description
string
methodpublicgetHeader( ) : string
inherited

Get the page header for the controller.

Inherited from: \modManagerController::getHeader()\ResourceManagerController::getHeader()
Returns
Type Description
string
methodpublicgetInstance( \modX $modx, string $className, array $config = array() ) : \modManagerController
staticinherited

Return the appropriate Resource controller class based on the class_key request parameter

Inherited from: \ResourceManagerController::getInstance()
Parameters
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

Returns
Type Description
\modManagerController The proper controller class
Details
Static
 
methodpublicgetLanguageTopics( ) : array
inherited

Specify the language topics to load

Inherited from: \ResourceManagerController::getLanguageTopics()
Returns
Type Description
array
methodpublicgetPageTitle( ) : string

Return the pagetitle

Returns
Type Description
string
methodpublicgetPlaceholder( string $k, mixed $default = null ) : mixed
inherited

Get a specific placeholder set

Inherited from: \modManagerController::getPlaceholder()\ResourceManagerController::getPlaceholder()
Parameters
Name Type Description
$k string
$default mixed
Returns
Type Description
mixed
methodpublicgetPlaceholders( ) : array
Returns
Type Description
array
methodpublicgetPreviewUrl( ) : string

Get url for resource for preview window

Returns
Type Description
string
methodprotectedgetReloadData( ) : void
methodpublicgetResource( ) : void

methodpublicgetResourceGroups( ) : void
methodpublicgetTemplateFile( ) : string

Return the location of the template file

Returns
Type Description
string
methodpublicgetTemplatesPaths( bool $coreOnly = false ) : array | string
inherited

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.

Parameters
Name Type Description
$coreOnly bool

Ensure that it grabs the path from the core namespace only.

Returns
Type Description
array | string
methodpublicinitialize( ) : void
inherited

Can be used to provide custom methods prior to processing

Inherited from: \modManagerController::initialize()\ResourceManagerController::initialize()
methodpublicloadController(  $controller, bool $coreOnly = false ) : mixed | string
inherited

Load another manual controller file (such as header/footer)

Inherited from: \modManagerController::loadController()\ResourceManagerController::loadController()
Parameters
Name Type Description
$controller
$coreOnly bool
Returns
Type Description
mixed | string
methodpublicloadControllersPath( ) : array
inherited

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()
Returns
Type Description
array
methodpublicloadCustomCssJs( ) : void

Register custom CSS/JS for the page

methodpublicloadRichTextEditor( ) : void
inherited

Initialize a RichText Editor, if set

Inherited from: \ResourceManagerController::loadRichTextEditor()
methodpublicloadTVs( array $reloadData = array() ) : string
inherited

Load the TVs for the Resource

Inherited from: \ResourceManagerController::loadTVs()
Parameters
Name Type Description
$reloadData array

resource data passed if reloading

Returns
Type Description
string The TV editing form
methodpublicloadTemplatesPath( ) : string
inherited

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()
Returns
Type Description
string
methodpublicloadWorkingContext( ) : \modContext | string
inherited

Load the working context for this controller.

Inherited from: \modManagerController::loadWorkingContext()\ResourceManagerController::loadWorkingContext()
Returns
Type Description
\modContext | string
methodpublicprepareLanguage( ) : void
inherited

Prepares the language placeholders

Inherited from: \modManagerController::prepareLanguage()\ResourceManagerController::prepareLanguage()
methodpublicprepareResource( ) : void
inherited

Used to set values on the resource record sent to the template for derivative classes

Inherited from: \ResourceManagerController::prepareResource()
methodpublicprocess( array $scriptProperties = array() ) : mixed

Process the controller, returning an array of placeholders to set.

Parameters
Name Type Description
$scriptProperties array

A array of REQUEST parameters.

Returns
Type Description
mixed Either an error or output string, or an array of placeholders to set.
methodpublicregisterBaseScripts( ) : void
inherited

Registers the core and base JS scripts

Inherited from: \modManagerController::registerBaseScripts()\ResourceManagerController::registerBaseScripts()
Details
Access
public  
methodpublicregisterCssJs( ) : void
inherited

Registers CSS/JS to manager interface

Inherited from: \modManagerController::registerCssJs()\ResourceManagerController::registerCssJs()
methodpublicrender( ) : string
inherited

Render the controller.

Inherited from: \modManagerController::render()\ResourceManagerController::render()
Returns
Type Description
string
methodpublicsetContext( ) : \modContext
inherited

Get and set the context for this resource

Inherited from: \ResourceManagerController::setContext()
Returns
Type Description
\modContext
methodpublicsetParent( ) : string
inherited

Get and set the parent for this resource

Inherited from: \ResourceManagerController::setParent()
Returns
Type Description
string The pagetitle of the parent
methodpublicsetPermissions( ) : void
inherited

Setup permissions for this page

Inherited from: \ResourceManagerController::setPermissions()
methodpublicsetPlaceholder( string $k, mixed $v ) : void
inherited

Set a placeholder for this controller's template

Inherited from: \modManagerController::setPlaceholder()\ResourceManagerController::setPlaceholder()
Parameters
Name Type Description
$k string

The key of the placeholder

$v mixed

The value of the placeholder

methodpublicsetPlaceholders( array $keys ) : void
Parameters
Name Type Description
$keys array
methodpublicsetProperties( array $properties ) : void
inherited

Sets the properties array for this controller

Inherited from: \modManagerController::setProperties()\ResourceManagerController::setProperties()
Parameters
Name Type Description
$properties array
methodpublicsetProperty( string $key, mixed $value ) : void
inherited

Set a property for this controller

Inherited from: \modManagerController::setProperty()\ResourceManagerController::setProperty()
Parameters
Name Type Description
$key string
$value mixed
methodpublicsetResourceToken( ) : void
inherited

Set token for validating a request

Inherited from: \ResourceManagerController::setResourceToken()
methodpublicsetTemplatePaths( array $paths ) : void
inherited

Set the possible template paths for this controller

Inherited from: \modManagerController::setTemplatePaths()\ResourceManagerController::setTemplatePaths()
Parameters
Name Type Description
$paths array
Documentation was generated by DocBlox 0.18.1.