model/modx/modx.class.php

package: modx
Constants: MODX_CORE_PATH; MODX_CONFIG_KEY
Classes: modX; modSystemEvent

Description

This is the main file to include in your scripts to use MODX.

For detailed information on using this class, see {@tutorial modx/modx.pkg}.

Constants

MODX_CORE_PATH
jump to top

 MODX_CORE_PATH = 'dirname(dirname(dirname(__FILE__))) . DIRECTORY_SEPARATOR'

Details

value: dirname(dirname(dirname(__FILE__))) . DIRECTORY_SEPARATOR

MODX_CONFIG_KEY
jump to top

 MODX_CONFIG_KEY = ''config''

Details

value: 'config'

\modSystemEvent
jump to top

package: modx
Constants: MODE_NEW; MODE_UPD
Properties: $_output; $_propagate; $activated; $activePlugin; $name; $params; $propertySet; $returnedValues
Methods: alert; isPropagatable; output; resetEventObject; stopPropagation

Description

Represents a modEvent when invoking events.

Constants

MODE_NEW
jump to class

\const MODE_NEW = 'new'

Details

value: new
: \const
For new creations of objects in model events

MODE_UPD
jump to class

\const MODE_UPD = 'upd'

Details

value: upd
: \const
For updating objects in model events

Properties

Details

visibility: public
default
final: false
static: false

Details

: boolean
visibility: protected
default: true
final: false
static: false

Details

: boolean
visibility: public
default
final: false
static: false

$activePlugin
jump to class

$activePlugin = ''

Details

visibility: public
default
final: false
static: false

Details

visibility: public
default
final: false
static: false

Details

: array
visibility: public
default
final: false
static: false

Details

visibility: public
default
final: false
static: false

$returnedValues
jump to class

mixed $returnedValues = ''

Details

: mixed
visibility: public
default
final: false
static: false

Methods

alert
jump to class

alert(
          string $msg
          )
        
        :

Display a message to the user during the event.

Arguments

$msg: string
The message to display.

Details

visibility: public
final: false
static: false
todo: Remove this; the centralized modRegistry will handle configurable logging of any kind of message or data to any repository or output context. Use {@link modX::_log()} in the meantime.

isPropagatable
jump to class

isPropagatable(
          
          )
        
        :
        boolean

Returns whether the event will propagate or not.

Output

boolean

Details

visibility: public
final: false
static: false
access: public

output
jump to class

output(
          string $output
          )
        
        :

Render output from the event.

Arguments

$output: string
The output to render.

Details

visibility: public
final: false
static: false

resetEventObject
jump to class

resetEventObject(
          
          )
        
        :

Reset the event instance for reuse.

Details

visibility: public
final: false
static: false

stopPropagation
jump to class

stopPropagation(
          
          )
        
        :

Stop further execution of plugins for this event.

Details

visibility: public
final: false
static: false

This includes preparing the session, pre-loading some common classes and objects, the current site and context settings, extension packages used to override session handling, error handling, or other initialization classes

Arguments

$contextKey: string
Indicates the context to initialize.

Details

visibility: public
final: false
static: false

invokeEvent
jump to class

invokeEvent(
          string $eventName, array $params
              =
              array
          )
        
        :

Invokes a specified Event with an optional array of parameters.

Arguments

$eventName: string
Name of an event to invoke.
$params: array
Optional params provided to the elements registered with an event.

Details

visibility: public
final: false
static: false
access: public
todo: refactor this completely, yuck!!

isInitialized
jump to class

isInitialized(
          
          )
        
        :
        boolean

Returns whether modX instance has been initialized or not.

Output

boolean

Details

visibility: public
final: false
static: false
access: public

lexicon
jump to class

lexicon(
          string $key, array $params
              =
              array
          )
        
        :

Grabs a processed lexicon string.

Arguments

$key: string
$params: array

Details

visibility: public
final: false
static: false
access: public

logManagerAction
jump to class

logManagerAction(
          string $action, string $class_key, mixed $item
          )
        
        :
        \modManagerLog

Logs a manager action.

Arguments

$action: string
The action to pull from the lexicon module.
$class_key: string
The class key that the action is being performed on.
$item: mixed
The primary key id or array of keys to grab the object with

Output

\modManagerLog: The newly created modManagerLog object

Details

visibility: public
final: false
static: false
access: public

makeUrl
jump to class

makeUrl(
          integer $id, string $context, string $args, mixed $scheme
              =
              1
          )
        
        :
        string

Generates a URL representing a specified resource.

Arguments

$id: integer
The id of a resource.
$context: string
Specifies a context to limit URL generation to.
$args: string
A query string to append to the generated URL.
$scheme: mixed
The scheme indicates in what format the URL is generated.<br> <pre> -1 : (default value) URL is relative to site_url 0 : see http 1 : see https full : URL is absolute, prepended with site_url from config abs : URL is absolute, prepended with base_url from config http : URL is absolute, forced to http scheme https : URL is absolute, forced to https scheme </pre>

Output

string: The URL for the resource.

Details

visibility: public
final: false
static: false

messageQuit
jump to class

messageQuit(
           $msg
              =
              unspecified error,  $query,  $is_error
              =
              true,  $nr,  $file,  $source,  $text,  $line
          )
        
        :

Legacy fatal error message.

Arguments

$msg
$query
$is_error
$nr
$file
$source
$text
$line

Details

visibility: public
final: false
static: false

parseChunk
jump to class

parseChunk(
          string $chunkName, array $chunkArr, string $prefix
              =
              [[+, string $suffix
              =
              ]]
          )
        
        :
        string

Parse a chunk using an associative array of replacement variables.

Arguments

$chunkName: string
The name of the chunk.
$chunkArr: array
An array of properties to replace in the chunk.
$prefix: string
The placeholder prefix, defaults to [[+.
$suffix: string
The placeholder suffix, defaults to ]].

Output

string: The processed chunk with the placeholders replaced.

Details

visibility: public
final: false
static: false

protect
jump to class

Harden the environment against common security flaws.

Details

visibility: public
final: false
static: true
static

regClientCSS
jump to class

regClientCSS(
          string $src
          )
        
        :

Arguments

$src: string
The CSS to be injected before the closing HEAD tag in an HTML response.

Details

visibility: public
final: false
static: false

regClientHTMLBlock
jump to class

regClientHTMLBlock(
          string $html
          )
        
        :

Arguments

$html: string
The HTML to be injected.

Details

visibility: public
final: false
static: false

regClientScript
jump to class

regClientScript(
          string $src, boolean $plaintext
              =
              false
          )
        
        :

Arguments

$src: string
The JavaScript to be injected before the closing BODY tag in an HTML response.
$plaintext: boolean
Optional param to treat the $src as plaintext rather than assuming it is JavaScript.

Details

visibility: public
final: false
static: false

regClientStartupHTMLBlock
jump to class

regClientStartupHTMLBlock(
          string $html
          )
        
        :

Arguments

$html: string
The HTML to be injected.

Details

visibility: public
final: false
static: false

regClientStartupScript
jump to class

regClientStartupScript(
          string $src, boolean $plaintext
              =
              false
          )
        
        :

Arguments

$src: string
The JavaScript to be injected before the closing HEAD tag of an HTML response.
$plaintext: boolean
Optional param to treat the $src as plaintext rather than assuming it is JavaScript.

Details

visibility: public
final: false
static: false

reloadConfig
jump to class

reloadConfig(
          
          )
        
        :
        array

Reload the config settings.

Output

array: An associative array of configuration key/values

Details

visibility: public
final: false
static: false

removeAllEventListener
jump to class

removeAllEventListener(
          
          )
        
        :

Remove all registered events for the current request.

Details

visibility: public
final: false
static: false

removeEventListener
jump to class

removeEventListener(
          string $event
          )
        
        :
        boolean

Remove an event from the eventMap so it will not be invoked.

Arguments

$event: string

Output

boolean: false if the event parameter is not specified or is not present in the eventMap.

Details

visibility: public
final: false
static: false

runProcessor
jump to class

runProcessor(
          string $action, array $scriptProperties
              =
              array, array $options
              =
              array
          )
        
        :
        mixed

Loads and runs a specific processor.

Arguments

$action: string
The processor to run, eg: context/update
$scriptProperties: array
Optional. An array of parameters to pass to the processor.
$options: array
Optional. An array of options for running the processor, such as: - processors_path - If specified, will override the default MODX processors path. - location - A prefix to load processor files from, will prepend to the action parameter (Note: location will be deprecated in future Revolution versions.)

Output

mixed: The result of the processor.

Details

visibility: public
final: false
static: false

runSnippet
jump to class

runSnippet(
          string $snippetName, array $params
              =
              array
          )
        
        :
        string

Process and return the output from a PHP snippet by name.

Arguments

$snippetName: string
The name of the snippet.
$params: array
An associative array of properties to pass to the snippet.

Output

string: The processed output of the snippet.

Details

visibility: public
final: false
static: false

sanitize
jump to class

sanitize(
          array $target, array|string $patterns
              =
              array, integer $depth
              =
              3,  $nesting
              =
              10
          )
        
        :
        array

Sanitize values of an array using regular expression patterns.

Arguments

$target: array
The target array to sanitize.
$patterns: arraystring
A regular expression pattern, or array of regular expression patterns to apply to all values of the target.
$depth: integer
The maximum recursive depth to sanitize if the target contains values that are arrays.
$nesting

Output

array: The sanitized array.

Details

visibility: public
final: false
static: true
static

sanitizeString
jump to class

sanitizeString(
          string $str, array $chars
              =
              array, string $allowedTags
          )
        
        :
        string

Sanitizes a string

Arguments

$str: string
The string to sanitize
$chars: array
An array of chars to remove
$allowedTags: string
A list of tags to allow.

Output

string: The sanitized string.

Details

visibility: public
final: false
static: false

sendError
jump to class

sendError(
          string $type, array $options
              =
              array
          )
        
        :

Send the user to a type-specific core error page and halt PHP execution.

Arguments

$type: string
The type of error to present.
$options: array
An array of options to provide for the error file.

Details

visibility: public
final: false
static: false

sendErrorPage
jump to class

sendErrorPage(
          array $options
              =
              null
          )
        
        :

Send the user to a MODX virtual error page.

Arguments

$options: array
An array of options to provide for the OnPageNotFound event and error page.

Details

visibility: public
final: false
static: false
uses: invokeEvent() The OnPageNotFound event is invoked before the error page is forwarded to.

sendForward
jump to class

sendForward(
          integer $id, string $options
              =
              null
          )
        
        :

Forwards the request to another resource without changing the URL.

Arguments

$id: integer
The resource identifier.
$options: string
An array of options for the process.

Details

visibility: public
final: false
static: false

sendRedirect
jump to class

sendRedirect(
          string $url, array|boolean $options
              =
              false, string $type, string $responseCode
          )
        
        :

Sends a redirect to the specified URL using the specified options.

Valid 'type' option values include: REDIRECT_REFRESH Uses the header refresh method REDIRECT_META Sends a a META HTTP-EQUIV="Refresh" tag to the output REDIRECT_HEADER Uses the header location method

REDIRECT_HEADER is the default.

Arguments

$url: string
The URL to redirect the client browser to.
$options: arrayboolean
An array of options for the redirect OR indicates if redirect attempts should be counted and limited to 3 (latter is deprecated usage; use count_attempts in options array).
$type: string
The type of redirection to attempt (deprecated, use type in options array).
$responseCode: string
The type of HTTP response code HEADER to send for the redirect (deprecated, use responseCode in options array)

Details

visibility: public
final: false
static: false

sendUnauthorizedPage
jump to class

sendUnauthorizedPage(
          array $options
              =
              null
          )
        
        :

Send the user to the MODX unauthorized page.

Arguments

$options: array
An array of options to provide for the OnPageUnauthorized event and unauthorized page.

Details

visibility: public
final: false
static: false
uses: invokeEvent() The OnPageUnauthorized event is invoked before the unauthorized page is forwarded to.

setDebug
jump to class

setDebug(
          boolean|int $debug
              =
              true, boolean $stopOnNotice
              =
              false
          )
        
        :
        boolean|int

Sets the debugging features of the modX instance.

Arguments

$debug: booleanint
Boolean or bitwise integer describing the debug state and/or PHP error reporting level.
$stopOnNotice: boolean
Indicates if processing should stop when encountering PHP errors of type E_NOTICE.

Output

boolean|int: The previous value.

Details

visibility: public
final: false
static: false

setPlaceholder
jump to class

setPlaceholder(
          string $key, mixed $value
          )
        
        :

Sets a placeholder value.

Arguments

$key: string
The unique string key which identifies the placeholder.
$value: mixed
The value to set the placeholder to.

Details

visibility: public
final: false
static: false

setPlaceholders
jump to class

setPlaceholders(
          array|object $placeholders, string $namespace
          )
        
        :

Sets a collection of placeholders stored in an array or as object vars.

An optional namespace parameter can be prepended to each placeholder key in the collection, to isolate the collection of placeholders.

Note that unlike toPlaceholders(), this function does not add separators between the namespace and the placeholder key. Use toPlaceholders() when working with multi-dimensional arrays or objects with variables other than scalars so each level gets delimited by a separator.

Arguments

$placeholders: arrayobject
An array of values or object to set as placeholders.
$namespace: string
A namespace prefix to prepend to each placeholder key.

Details

visibility: public
final: false
static: false

stripTags
jump to class

stripTags(
           $html,  $allowed,  $patterns
              =
              array,  $depth
              =
              10
          )
        
        :

Strip unwanted HTML and PHP tags and supplied patterns from content.

Arguments

$html
$allowed
$patterns
$depth

Details

visibility: public
final: false
static: false

switchContext
jump to class

switchContext(
          string $contextKey
          )
        
        :
        boolean

Switches the primary Context for the modX instance.

Be aware that switching contexts does not allow custom session handling classes to be loaded. The gateway defines the session handling that is applied to a single request. To create a context with a custom session handler you must create a unique context gateway that initializes that context directly.

Arguments

$contextKey: string
The key of the context to switch to.

Output

boolean: True if the switch was successful, otherwise false.

Details

visibility: public
final: false
static: false

toPlaceholder
jump to class

toPlaceholder(
          string $key, mixed $value, string $prefix, string $separator
              =
              ., boolean $restore
              =
              false
          )
        
        :
        array

Recursively validates and sets placeholders appropriate to the value type passed.

Arguments

$key: string
The key identifying the value.
$value: mixed
The value to set.
$prefix: string
A string prefix to prepend to the key. Recursive calls prepend the parent keys as well.
$separator: string
A separator placed in between the prefix and the key. Default is a dot or period: '.'.
$restore: boolean
Set to true if you want overwritten placeholder values returned.

Output

array: A multi-dimensional array containing up to two elements: 'keys' which always contains an array of placeholder keys that were set, and optionally, if the restore parameter is true, 'restore' containing an array of placeholder values that were overwritten by the method.

Details

visibility: public
final: false
static: false

toPlaceholders
jump to class

toPlaceholders(
          array|object $subject, string $prefix, string $separator
              =
              ., boolean $restore
              =
              false
          )
        
        :
        array

Sets placeholders from values stored in arrays and objects.

Each recursive level adds to the prefix, building an access path using an optional separator.

Arguments

$subject: arrayobject
An array or object to process.
$prefix: string
An optional prefix to be prepended to the placeholder keys. Recursive calls prepend the parent keys.
$separator: string
A separator to place in between the prefixes and keys. Default is a dot or period: '.'.
$restore: boolean
Set to true if you want overwritten placeholder values returned.

Output

array: A multi-dimensional array containing up to two elements: 'keys' which always contains an array of placeholder keys that were set, and optionally, if the restore parameter is true, 'restore' containing an array of placeholder values that were overwritten by the method.

Details

visibility: public
final: false
static: false

toQueryString
jump to class

toQueryString(
          array $parameters
              =
              array
          )
        
        :
        string

Turn an associative array into a valid query string.

Arguments

$parameters: array
An associative array of parameters.

Output

string: A valid query string representing the parameters.

Details

visibility: public
final: false
static: true
static

unsetPlaceholder
jump to class

unsetPlaceholder(
          string $key
          )
        
        :

Unset a placeholder value by key.

Arguments

$key: string
The key of the placeholder to unset.

Details

visibility: public
final: false
static: false

unsetPlaceholders
jump to class

unsetPlaceholders(
          string|array $keys
          )
        
        :

Unset multiple placeholders, either by prefix or an array of keys.

Arguments

$keys: stringarray
A string prefix or an array of keys indicating the placeholders to unset.

Details

visibility: public
final: false
static: false

model/modx/modx.class.php

Description

Constants

MODX_CORE_PATHjump to top

Details

MODX_CONFIG_KEYjump to top

Details

\modSystemEventjump to top

Description

Constants

MODE_NEWjump to class

Details

MODE_UPDjump to class

Details

Properties

$_outputjump to class

Details

$_propagatejump to class

Details

$activatedjump to class

Details

$activePluginjump to class

Details

$namejump to class

Details

$paramsjump to class

Details

$propertySetjump to class

Details

$returnedValuesjump to class

Details

Methods

alertjump to class

Arguments

Details

isPropagatablejump to class

Output

Details

outputjump to class

Arguments

Details

resetEventObjectjump to class

Details

stopPropagationjump to class

Details

\modXjump to top

Description

Constants

LOG_LEVEL_FATALjump to class

Details

LOG_LEVEL_ERRORjump to class

Details

LOG_LEVEL_WARNjump to class

Details

LOG_LEVEL_INFOjump to class

Details

LOG_LEVEL_DEBUGjump to class

Details

SESSION_STATE_UNAVAILABLEjump to class

Details

SESSION_STATE_UNINITIALIZEDjump to class

Details

SESSION_STATE_INITIALIZEDjump to class

Details

SESSION_STATE_EXTERNALjump to class

Details

Properties

$Eventjump to class

Details

$_configA config array that stores the bootstrap settings.jump to class

Details

$_initializedIndicates if modX has been successfully initialized for a modContext.jump to class

Details

$_logSequencejump to class

Details

$_sessionStateAn integer representing the session state of modX.jump to class

Details

$_systemConfigA config array that stores the system-wide settings.jump to class

Details

$_userConfigA config array that stores the user settings.jump to class

MODX_CORE_PATH
jump to top

MODX_CONFIG_KEY
jump to top

\modSystemEvent
jump to top

MODE_NEW
jump to class

MODE_UPD
jump to class

$_output
jump to class

$_propagate
jump to class

$activated
jump to class

$activePlugin
jump to class

$name
jump to class

$params
jump to class

$propertySet
jump to class

$returnedValues
jump to class

alert
jump to class

isPropagatable
jump to class

output
jump to class

resetEventObject
jump to class

stopPropagation
jump to class

\modX
jump to top

LOG_LEVEL_FATAL
jump to class

LOG_LEVEL_ERROR
jump to class

LOG_LEVEL_WARN
jump to class

LOG_LEVEL_INFO
jump to class

LOG_LEVEL_DEBUG
jump to class

SESSION_STATE_UNAVAILABLE
jump to class

SESSION_STATE_UNINITIALIZED
jump to class

SESSION_STATE_INITIALIZED
jump to class

SESSION_STATE_EXTERNAL
jump to class

$Event
jump to class

$_configA config array that stores the bootstrap settings.
jump to class

$_initializedIndicates if modX has been successfully initialized for a modContext.
jump to class

$_logSequence
jump to class

$_sessionStateAn integer representing the session state of modX.
jump to class

$_systemConfigA config array that stores the system-wide settings.
jump to class

$_userConfigA config array that stores the user settings.
jump to class

$actionMapA map of actions registered to the manager interface.
jump to class

$aliasMapA lookup listing of Resource alias values and associated Resource Ids
jump to class

$contentTypesRepresents the modContentType instances that can be delivered by this modX deployment.
jump to class

$contextThe Context represents a unique section of the site which this modX instance is controlling.
jump to class

$contextsAn array of secondary contexts loaded on demand.
jump to class

$cultureKeyThe preferred Culture key for the current request.
jump to class

$documentOutput
jump to class

$elementCacheA map of already processed Elements.
jump to class

$errorHandlerAn error_handler for the modX instance.
jump to class

$eventThe current event being handled by modX.
jump to class

$eventMapA map of elements registered to specific events.
jump to class

$jscriptsAn array of javascript content to be inserted into the BODY of an HTML resource.
jump to class

$lexiconRepresents a localized dictionary of common words and phrases.
jump to class

$loadedjscripts
jump to class

$parserThe modParser registered for this modX instance, responsible for content tag parsing, and loaded only on demand.
jump to class

$placeholdersAn array of key=> value pairs that can be used by any Resource or Element.
jump to class

$pluginCache
jump to class

$requestRepresents a web request and provides helper methods for dealing with request parameters and other attributes of a request.
jump to class

$resourceAn instance of the current modResource controlling the request.
jump to class

$resourceGeneratedIndicates if the resource was generated during this request.
jump to class

$resourceIdentifierThe resource id or alias being requested.
jump to class

$resourceListingA listing of site Resources and Context-specific meta data.
jump to class

$resourceMapA hierarchy map of Resources.
jump to class

$resourceMethodThe method to use to locate the Resource, 'id' or 'alias'.
jump to class

$responseRepresents a web response, providing helper methods for managing response header attributes and the body containing the content of the response.
jump to class

$sanitizePatternsAn array of regex patterns regulary cleansed from content.
jump to class

$servicesAn array of supplemental service classes for this modX instance.
jump to class

$sjscriptsAn array of javascript content to be inserted into the HEAD of an HTML resource.
jump to class

$sourceCache
jump to class

$stopOnNotice
jump to class

$userThe current user object, if one is authenticated for the current request and context.
jump to class

$versionVersion information for this MODX deployment.
jump to class

$virtualDirStores the virtual path for a request to MODX if the friendly_alias_paths option is enabled.
jump to class

__construct
jump to class