manager/controllers/default/system/dashboards/update.class.php

Show:

inherited

Classes
- \SystemDashboardsUpdateManagerController

Table of Contents

Package: modx
Subpackage: manager.controllers

\SystemDashboardsUpdateManagerController
jump to top

Package: modx\manager\controllers

Loads the dashboard update page

Parent(s): \modManagerController

Properties

array
                 $config= 'array()'

inherited

A configuration array of options related to this controller's action object.Inherited from: \modManagerController::$$config

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$config

string
                 $content= ''''

inherited

The current output contentInherited from: \modManagerController::$$content

Default value''Details

Type: string
Inherited_from: \modManagerController::$$content

array
                 $controllersPaths= ''

inherited

An array of possible paths to this controller's directory.Inherited from: \modManagerController::$$controllersPaths

Details

Type: array
Inherited_from: \modManagerController::$$controllersPaths

\modDashboard
                 $dashboard= ''

Details

Type: \modDashboard

array
                 $dashboardArray= ''

Details

Type: array

\modMediaSource
                 $defaultSource= ''

inherited

The default media source for the userInherited from: \modManagerController::$$defaultSource

Details

Type: \modMediaSource
Inherited_from: \modManagerController::$$defaultSource

string
                 $failureMessage= ''''

inherited

The failure message, if existent, for this controller.Inherited from: \modManagerController::$$failureMessage

Default value''Details

Type: string
Inherited_from: \modManagerController::$$failureMessage

array
                 $head= 'array('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())'

inherited

An array of css/js/html to load into the HEAD of the pageInherited from: \modManagerController::$$head

Default valuearray('css' => array(),'js' => array(),'html' => array(),'lastjs' => array())Details

Type: array
Inherited_from: \modManagerController::$$head

bool
                 $isFailure= 'false'

inherited

Whether or not a failure message was sent by this controller.Inherited from: \modManagerController::$$isFailure

Default valuefalseDetails

Type: bool
Inherited_from: \modManagerController::$$isFailure

bool
                 $loadBaseJavascript= 'true'

inherited

Set to false to prevent loading of the base MODExt JS classes.Inherited from: \modManagerController::$$loadBaseJavascript

Default valuetrueDetails

Type: bool
Inherited_from: \modManagerController::$$loadBaseJavascript

bool
                 $loadFooter= 'true'

inherited

Set to false to prevent loading of the footer HTML.Inherited from: \modManagerController::$$loadFooter

Default valuetrueDetails

Type: bool
Inherited_from: \modManagerController::$$loadFooter

bool
                 $loadHeader= 'true'

inherited

Set to false to prevent loading of the header HTML.Inherited from: \modManagerController::$$loadHeader

Default valuetrueDetails

Type: bool
Inherited_from: \modManagerController::$$loadHeader

\modX
                 $modx= ''

inherited

A reference to the modX objectInherited from: \modManagerController::$$modx

Details

Type: \modX
Inherited_from: \modManagerController::$$modx

array
                 $placeholders= 'array()'

inherited

An array of placeholders that are being set to the pageInherited from: \modManagerController::$$placeholders

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$placeholders

string
                 $ruleOutput= 'array()'

inherited

Any Form Customization rule output that was created.Inherited from: \modManagerController::$$ruleOutput

Default valuearray()Details

Type: string
Inherited_from: \modManagerController::$$ruleOutput

array
                 $scriptProperties= 'array()'

inherited

An array of request parameters sent to the controllerInherited from: \modManagerController::$$scriptProperties

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$scriptProperties

array
                 $templatesPaths= 'array()'

inherited

An array of possible paths to this controller's templates directory.Inherited from: \modManagerController::$$templatesPaths

Default valuearray()Details

Type: array
Inherited_from: \modManagerController::$$templatesPaths

string
                 $theme= ''default''

inherited

The current manager theme.Inherited from: \modManagerController::$$theme

Default value'default'Details

Type: string
Inherited_from: \modManagerController::$$theme

string
                 $title= ''''

inherited

The pagetitle for this controller.Inherited from: \modManagerController::$$title

Default value''Details

Type: string
Inherited_from: \modManagerController::$$title

\modContext
                 $workingContext= ''

inherited

The current working context.Inherited from: \modManagerController::$$workingContext

Details

Type: \modContext
Inherited_from: \modManagerController::$$workingContext

Methods

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

inherited

The constructor for the modManaagerController class.

Inherited from: \modManagerController::__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.

_postfixVersionToScript(
          string $str, string $version
          )
        
        :
          string

inherited

Appends a version postfix to a script tag

Inherited from: \modManagerController::_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

_prepareHead(
          
          )
        
        :
          void

inherited

Prepare the set html/css/js to be added

Inherited from: \modManagerController::_prepareHead()

_prepareVersionPostfix(
          
          )
        
        :
          string

inherited

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

Inherited from: \modManagerController::_prepareVersionPostfix()

Returns

Type	Description
string	The parsed version string

Details

Access: private

addCss(
          string $script
          )
        
        :
          void

inherited

Add a external CSS file to the head of the page

Inherited from: \modManagerController::addCss()

Parameters

Name	Type	Description
$script	string

addHtml(
          string $script
          )
        
        :
          void

inherited

Add a block of HTML to the head of the page

Inherited from: \modManagerController::addHtml()

Parameters

Name	Type	Description
$script	string

addJavascript(
          string $script
          )
        
        :
          void

inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addJavascript()

Parameters

Name	Type	Description
$script	string

addLastJavascript(
          string $script
          )
        
        :
          void

inherited

Add an external Javascript file to the head of the page

Inherited from: \modManagerController::addLastJavascript()

Parameters

Name	Type	Description
$script	string

addLexiconTopic(
          string $topic
          )
        
        :
          string

inherited

Adds a topic to the JS language array

Inherited from: \modManagerController::addLexiconTopic()

Parameters

Name	Type	Description
$topic	string

Returns

Type	Description
string

assignPlaceholders(
          
          )
        
        :
          void

inherited

Inherited from: \modManagerController::assignPlaceholders()

checkFormCustomizationRules(
          \xPDOObject $obj
              =
              null, bool $forParent
              =
              false
          )
        
        :
          bool

inherited

Checks Form Customization rules for an object.

Inherited from: \modManagerController::checkFormCustomizationRules()

Parameters

Name	Type	Description
$obj	\xPDOObject	If passed, will validate against for rules with constraints.
$forParent	bool

Returns

Type	Description
bool

checkPermissions(
          
          )
        
        :
          bool

Check for any permissions or requirements to load page

Returns

Type	Description
bool

failure(
          string $message
          )
        
        :
          void

inherited

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

Inherited from: \modManagerController::failure()

Parameters

Name	Type	Description
$message	string

fetchTemplate(
          string $tpl
          )
        
        :
          string

inherited

Fetch the template content

Inherited from: \modManagerController::fetchTemplate()

Parameters

Name	Type	Description
$tpl	string	The path to the template

Returns

Type	Description
string	The output of the template

firePostRenderEvents(
          
          )
        
        :
          void

inherited

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

Inherited from: \modManagerController::firePostRenderEvents()

firePreRenderEvents(
          
          )
        
        :
          void

inherited

Fire any pre-render events for the controller

Inherited from: \modManagerController::firePreRenderEvents()

getControllersPaths(
          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()

Parameters

Name	Type	Description
$coreOnly	bool	Ensure that it grabs the path from the core namespace only.

Returns

Type	Description
array

getDefaultState(
          
          )
        
        :
          array | mixed | string

inherited

Get the default state for the UI

Inherited from: \modManagerController::getDefaultState()

Returns

Type	Description
array \| mixed \| string

getFooter(
          
          )
        
        :
          string

inherited

Get the page footer for the controller.

Inherited from: \modManagerController::getFooter()

Returns

Type	Description
string

getHeader(
          
          )
        
        :
          string

inherited

Get the page header for the controller.

Inherited from: \modManagerController::getHeader()

Returns

Type	Description
string

getInstance(
          \modX $modx, string $className, array $config
              =
              array()
          )
        
        :
          \The

staticinherited

Return the proper instance of the derived class. This can be used to override how the manager loads a controller class; for example, when handling derivative classes with class_key settings.

Inherited from: \modManagerController::getInstance()

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX object.
$className	string	The name of the class that is being requested.
$config	array	A configuration array of options related to this controller's action object.

Returns

Type	Description
\The	class specified by $className

Details

Static

getLanguageTopics(
          
          )
        
        :
          array

Specify the language topics to load

Returns

Type	Description
array

getPageTitle(
          
          )
        
        :
          string

Return the pagetitle

Returns

Type	Description
string

getPlaceholder(
          string $k, mixed $default
              =
              null
          )
        
        :
          mixed

inherited

Get a specific placeholder set

Inherited from: \modManagerController::getPlaceholder()

Parameters

Name	Type	Description
$k	string
$default	mixed

Returns

Type	Description
mixed

getPlaceholders(
          
          )
        
        :
          array

inherited

Get all the set placeholders

Inherited from: \modManagerController::getPlaceholders()

Returns

Type	Description
array

getTemplateFile(
          
          )
        
        :
          string

Return the location of the template file

Returns

Type	Description
string

getTemplatesPaths(
          bool $coreOnly
              =
              false
          )
        
        :
          array | string

inherited

Get an array of possible paths to this controller's template's directory.

Inherited from: \modManagerController::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

getUserGroups(
          
          )
        
        :
          array

Get all the User Groups assigned to this Dashboard

Returns

Type	Description
array

getWidgets(
          
          )
        
        :
          array

Get all the Widgets placed on this Dashboard

Returns

Type	Description
array

initialize(
          
          )
        
        :
          void

inherited

Can be used to provide custom methods prior to processing

Inherited from: \modManagerController::initialize()

loadController(
           $controller, bool $coreOnly
              =
              false
          )
        
        :
          mixed | string

inherited

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

Inherited from: \modManagerController::loadController()

Parameters

Name	Type	Description
$controller
$coreOnly	bool

Returns

Type	Description
mixed \| string

loadControllersPath(
          
          )
        
        :
          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()

Returns

Type	Description
array

loadCustomCssJs(
          
          )
        
        :
          void

loadTemplatesPath(
          
          )
        
        :
          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()

Returns

Type	Description
string

loadWorkingContext(
          
          )
        
        :
          \modContext | string

inherited

Load the working context for this controller.

Inherited from: \modManagerController::loadWorkingContext()

Returns

Type	Description
\modContext \| string

prepareLanguage(
          
          )
        
        :
          void

inherited

Prepares the language placeholders

Inherited from: \modManagerController::prepareLanguage()

process(
          array $scriptProperties
              =
              array()
          )
        
        :
          array

Custom logic code here for setting placeholders, etc

Parameters

Name	Type	Description
$scriptProperties	array

Returns

Type	Description
array

registerBaseScripts(
          
          )
        
        :
          void

inherited

Registers the core and base JS scripts

Inherited from: \modManagerController::registerBaseScripts()

Details

Access: public

registerCssJs(
          
          )
        
        :
          void

inherited

Registers CSS/JS to manager interface

Inherited from: \modManagerController::registerCssJs()

render(
          
          )
        
        :
          string

inherited

Render the controller.

Inherited from: \modManagerController::render()

Returns

Type	Description
string

setPlaceholder(
          string $k, mixed $v
          )
        
        :
          void

inherited

Set a placeholder for this controller's template

Inherited from: \modManagerController::setPlaceholder()

Parameters

Name	Type	Description
$k	string	The key of the placeholder
$v	mixed	The value of the placeholder

setPlaceholders(
          array $keys
          )
        
        :
          void

inherited

Set an array of placeholders

Inherited from: \modManagerController::setPlaceholders()

Parameters

Name	Type	Description
$keys	array

setProperties(
          array $properties
          )
        
        :
          void

inherited

Sets the properties array for this controller

Inherited from: \modManagerController::setProperties()

Parameters

Name	Type	Description
$properties	array

setProperty(
          string $key, mixed $value
          )
        
        :
          void

inherited

Set a property for this controller

Inherited from: \modManagerController::setProperty()

Parameters

Name	Type	Description
$key	string
$value	mixed

setTemplatePaths(
          array $paths
          )
        
        :
          void

inherited

Set the possible template paths for this controller

Inherited from: \modManagerController::setTemplatePaths()

Parameters

Name	Type	Description
$paths	array

manager/controllers/default/system/dashboards/update.class.php

\SystemDashboardsUpdateManagerControllerjump to top

Properties

Methods

\SystemDashboardsUpdateManagerController
jump to top