manager/controllers/default/resource/staticresource/create.class.php
- Package
- modx
- Subpackage
- manager.controllers
\StaticResourceCreateManagerController
Loads the create resource page
Properties
$canCreate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canCreate
- Inherited_from
- \ResourceCreateManagerController::$$canCreate
$canDelete= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDelete
- Inherited_from
- \ResourceCreateManagerController::$$canDelete
$canDuplicate= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canDuplicate
- Inherited_from
- \ResourceCreateManagerController::$$canDuplicate
$canEdit= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canEdit
- Inherited_from
- \ResourceCreateManagerController::$$canEdit
$canPublish= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canPublish
- Inherited_from
- \ResourceCreateManagerController::$$canPublish
$canSave= 'true'
true
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$canSave
- Inherited_from
- \ResourceCreateManagerController::$$canSave
array
$config= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$config
- Inherited_from
- \ResourceManagerController::$$config
- Inherited_from
- \ResourceCreateManagerController::$$config
string
$content= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$content
- Inherited_from
- \ResourceManagerController::$$content
- Inherited_from
- \ResourceCreateManagerController::$$content
\modContext
$context= ''
- Type
- \modContext
- Inherited_from
- \ResourceManagerController::$$context
- Inherited_from
- \ResourceCreateManagerController::$$context
array
$controllersPaths= ''
- Type
- array
- Inherited_from
- \modManagerController::$$controllersPaths
- Inherited_from
- \ResourceManagerController::$$controllersPaths
- Inherited_from
- \ResourceCreateManagerController::$$controllersPaths
$ctx= ''web''
'web'
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$ctx
- Inherited_from
- \ResourceCreateManagerController::$$ctx
\modMediaSource
$defaultSource= ''
- Type
- \modMediaSource
- Inherited_from
- \modManagerController::$$defaultSource
- Inherited_from
- \ResourceManagerController::$$defaultSource
- Inherited_from
- \ResourceCreateManagerController::$$defaultSource
string
$failureMessage= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$failureMessage
- Inherited_from
- \ResourceManagerController::$$failureMessage
- Inherited_from
- \ResourceCreateManagerController::$$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
- \ResourceCreateManagerController::$$head
bool
$isFailure= 'false'
false
Details- Type
- bool
- Inherited_from
- \modManagerController::$$isFailure
- Inherited_from
- \ResourceManagerController::$$isFailure
- Inherited_from
- \ResourceCreateManagerController::$$isFailure
bool
$loadBaseJavascript= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadBaseJavascript
- Inherited_from
- \ResourceManagerController::$$loadBaseJavascript
- Inherited_from
- \ResourceCreateManagerController::$$loadBaseJavascript
bool
$loadFooter= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadFooter
- Inherited_from
- \ResourceManagerController::$$loadFooter
- Inherited_from
- \ResourceCreateManagerController::$$loadFooter
bool
$loadHeader= 'true'
true
Details- Type
- bool
- Inherited_from
- \modManagerController::$$loadHeader
- Inherited_from
- \ResourceManagerController::$$loadHeader
- Inherited_from
- \ResourceCreateManagerController::$$loadHeader
\modX
$modx= ''
- Type
- \modX
- Inherited_from
- \modManagerController::$$modx
- Inherited_from
- \ResourceManagerController::$$modx
- Inherited_from
- \ResourceCreateManagerController::$$modx
$onDocFormRender= ''''
''
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$onDocFormRender
- Inherited_from
- \ResourceCreateManagerController::$$onDocFormRender
\modResource
$parent= ''
- Type
- \modResource
- Inherited_from
- \ResourceManagerController::$$parent
- Inherited_from
- \ResourceCreateManagerController::$$parent
array
$placeholders= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$placeholders
- Inherited_from
- \ResourceManagerController::$$placeholders
- Inherited_from
- \ResourceCreateManagerController::$$placeholders
\modRegister
$reg= ''
- Type
- \modRegister
- Inherited_from
- \ResourceManagerController::$$reg
- Inherited_from
- \ResourceCreateManagerController::$$reg
\modResource
$resource= ''
- Type
- \modResource
- Inherited_from
- \ResourceManagerController::$$resource
- Inherited_from
- \ResourceCreateManagerController::$$resource
$resourceArray= 'array()'
array()
Details- Type
- n/a
- Inherited_from
- \ResourceManagerController::$$resourceArray
- Inherited_from
- \ResourceCreateManagerController::$$resourceArray
string
$resourceClass= ''modDocument''
'modDocument'
Details- Type
- string
- Inherited_from
- \ResourceManagerController::$$resourceClass
- Inherited_from
- \ResourceCreateManagerController::$$resourceClass
array
$rteFields= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$rteFields
- Inherited_from
- \ResourceCreateManagerController::$$rteFields
string
$ruleOutput= 'array()'
array()
Details- Type
- string
- Inherited_from
- \modManagerController::$$ruleOutput
- Inherited_from
- \ResourceManagerController::$$ruleOutput
- Inherited_from
- \ResourceCreateManagerController::$$ruleOutput
array
$scriptProperties= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$scriptProperties
- Inherited_from
- \ResourceManagerController::$$scriptProperties
- Inherited_from
- \ResourceCreateManagerController::$$scriptProperties
array
$templatesPaths= 'array()'
array()
Details- Type
- array
- Inherited_from
- \modManagerController::$$templatesPaths
- Inherited_from
- \ResourceManagerController::$$templatesPaths
- Inherited_from
- \ResourceCreateManagerController::$$templatesPaths
string
$theme= ''default''
'default'
Details- Type
- string
- Inherited_from
- \modManagerController::$$theme
- Inherited_from
- \ResourceManagerController::$$theme
- Inherited_from
- \ResourceCreateManagerController::$$theme
string
$title= ''''
''
Details- Type
- string
- Inherited_from
- \modManagerController::$$title
- Inherited_from
- \ResourceManagerController::$$title
- Inherited_from
- \ResourceCreateManagerController::$$title
array
$tvCounts= 'array()'
array()
Details- Type
- array
- Inherited_from
- \ResourceManagerController::$$tvCounts
- Inherited_from
- \ResourceCreateManagerController::$$tvCounts
\modContext
$workingContext= ''
- Type
- \modContext
- Inherited_from
- \modManagerController::$$workingContext
- Inherited_from
- \ResourceManagerController::$$workingContext
- Inherited_from
- \ResourceCreateManagerController::$$workingContext
Methods
__construct(
\modX $modx, array $config
=
array()
)
:
void
The constructor for the modManaagerController class.
Inherited from: \modManagerController::__construct()\ResourceManagerController::__construct()\ResourceCreateManagerController::__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()\ResourceCreateManagerController::_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()\ResourceCreateManagerController::_prepareHead()_prepareVersionPostfix(
)
:
string
Grabs a stripped version of modx to prevent caching of JS after upgrades
Inherited from: \modManagerController::_prepareVersionPostfix()\ResourceManagerController::_prepareVersionPostfix()\ResourceCreateManagerController::_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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::addLastJavascript()Name | Type | Description |
---|---|---|
$script | string |
addLexiconTopic(
string $topic
)
:
string
Adds a topic to the JS language array
Inherited from: \modManagerController::addLexiconTopic()\ResourceManagerController::addLexiconTopic()\ResourceCreateManagerController::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()\ResourceCreateManagerController::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: \ResourceCreateManagerController::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()\ResourceCreateManagerController::failure()Name | Type | Description |
---|---|---|
$message | string |
fetchTemplate(
string $tpl
)
:
string
Fetch the template content
Inherited from: \modManagerController::fetchTemplate()\ResourceManagerController::fetchTemplate()\ResourceCreateManagerController::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()\ResourceCreateManagerController::fireOnRenderEvent()Type | Description |
---|---|
string |
fireOnTVFormRender(
)
:
mixed
Fire the TV Form Render event
Inherited from: \ResourceManagerController::fireOnTVFormRender()\ResourceCreateManagerController::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()\ResourceCreateManagerController::firePostRenderEvents()firePreRenderEvents(
)
:
array | bool | string
Fire any pre-render events
Inherited from: \ResourceManagerController::firePreRenderEvents()\ResourceCreateManagerController::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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::getDefaultState()Type | Description |
---|---|
array | mixed | string |
getDefaultTemplate(
)
:
int
Return the default template for this resource
Inherited from: \ResourceCreateManagerController::getDefaultTemplate()Type | Description |
---|---|
int |
getFooter(
)
:
string
Get the page footer for the controller.
Inherited from: \modManagerController::getFooter()\ResourceManagerController::getFooter()\ResourceCreateManagerController::getFooter()Type | Description |
---|---|
string |
getHeader(
)
:
string
Get the page header for the controller.
Inherited from: \modManagerController::getHeader()\ResourceManagerController::getHeader()\ResourceCreateManagerController::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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::getLanguageTopics()Type | Description |
---|---|
array |
getPlaceholder(
string $k, mixed $default
=
null
)
:
mixed
Get a specific placeholder set
Inherited from: \modManagerController::getPlaceholder()\ResourceManagerController::getPlaceholder()\ResourceCreateManagerController::getPlaceholder()Name | Type | Description |
---|---|---|
$k | string | |
$default | mixed |
Type | Description |
---|---|
mixed |
getPlaceholders(
)
:
array
Get all the set placeholders
Inherited from: \modManagerController::getPlaceholders()\ResourceManagerController::getPlaceholders()\ResourceCreateManagerController::getPlaceholders()Type | Description |
---|---|
array |
getReloadData(
)
:
void
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()\ResourceCreateManagerController::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()\ResourceCreateManagerController::initialize()loadController(
$controller, bool $coreOnly
=
false
)
:
mixed | string
Load another manual controller file (such as header/footer)
Inherited from: \modManagerController::loadController()\ResourceManagerController::loadController()\ResourceCreateManagerController::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()\ResourceCreateManagerController::loadControllersPath()Type | Description |
---|---|
array |
loadRichTextEditor(
)
:
void
Initialize a RichText Editor, if set
Inherited from: \ResourceManagerController::loadRichTextEditor()\ResourceCreateManagerController::loadRichTextEditor()loadTVs(
array $reloadData
=
array()
)
:
string
Load the TVs for the Resource
Inherited from: \ResourceManagerController::loadTVs()\ResourceCreateManagerController::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()\ResourceCreateManagerController::loadTemplatesPath()Type | Description |
---|---|
string |
loadWorkingContext(
)
:
\modContext | string
Load the working context for this controller.
Inherited from: \modManagerController::loadWorkingContext()\ResourceManagerController::loadWorkingContext()\ResourceCreateManagerController::loadWorkingContext()Type | Description |
---|---|
\modContext | string |
prepareLanguage(
)
:
void
Prepares the language placeholders
Inherited from: \modManagerController::prepareLanguage()\ResourceManagerController::prepareLanguage()\ResourceCreateManagerController::prepareLanguage()prepareResource(
)
:
void
Used to set values on the resource record sent to the template for derivative classes
Inherited from: \ResourceManagerController::prepareResource()\ResourceCreateManagerController::prepareResource()process(
array $scriptProperties
=
array()
)
:
mixed
Custom logic code here for setting placeholders, etc
Inherited from: \ResourceCreateManagerController::process()Name | Type | Description |
---|---|---|
$scriptProperties | array |
Type | Description |
---|---|
mixed |
registerBaseScripts(
)
:
void
Registers the core and base JS scripts
Inherited from: \modManagerController::registerBaseScripts()\ResourceManagerController::registerBaseScripts()\ResourceCreateManagerController::registerBaseScripts()- Access
- public
registerCssJs(
)
:
void
Registers CSS/JS to manager interface
Inherited from: \modManagerController::registerCssJs()\ResourceManagerController::registerCssJs()\ResourceCreateManagerController::registerCssJs()render(
)
:
string
Render the controller.
Inherited from: \modManagerController::render()\ResourceManagerController::render()\ResourceCreateManagerController::render()Type | Description |
---|---|
string |
setContext(
)
:
\modContext
Get and set the context for this resource
Inherited from: \ResourceManagerController::setContext()\ResourceCreateManagerController::setContext()Type | Description |
---|---|
\modContext |
setParent(
)
:
string
Get and set the parent for this resource
Inherited from: \ResourceManagerController::setParent()\ResourceCreateManagerController::setParent()Type | Description |
---|---|
string | The pagetitle of the parent |
setPermissions(
)
:
void
Setup permissions for this page
Inherited from: \ResourceManagerController::setPermissions()\ResourceCreateManagerController::setPermissions()setPlaceholder(
string $k, mixed $v
)
:
void
Set a placeholder for this controller's template
Inherited from: \modManagerController::setPlaceholder()\ResourceManagerController::setPlaceholder()\ResourceCreateManagerController::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()\ResourceCreateManagerController::setPlaceholders()Name | Type | Description |
---|---|---|
$keys | array |
setProperties(
array $properties
)
:
void
Sets the properties array for this controller
Inherited from: \modManagerController::setProperties()\ResourceManagerController::setProperties()\ResourceCreateManagerController::setProperties()Name | Type | Description |
---|---|---|
$properties | array |
setProperty(
string $key, mixed $value
)
:
void
Set a property for this controller
Inherited from: \modManagerController::setProperty()\ResourceManagerController::setProperty()\ResourceCreateManagerController::setProperty()Name | Type | Description |
---|---|---|
$key | string | |
$value | mixed |
setResourceToken(
)
:
void
Set token for validating a request
Inherited from: \ResourceManagerController::setResourceToken()\ResourceCreateManagerController::setResourceToken()setTemplatePaths(
array $paths
)
:
void
Set the possible template paths for this controller
Inherited from: \modManagerController::setTemplatePaths()\ResourceManagerController::setTemplatePaths()\ResourceCreateManagerController::setTemplatePaths()Name | Type | Description |
---|---|---|
$paths | array |