array $aliasMap = null (line 104)

• var: A lookup listing of Resource alias values and associated Resource Ids
• access: public

modContext $context = null (line 67)

• var: The Context represents a unique section of the site which this modX instance is controlling.
• access: public

string $cultureKey = '' (line 134)

• var: The preferred Culture key for the current request.
• access: public

mixed $documentContent = null (line 237)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

mixed $documentIdentifier = null (line 235)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

mixed $documentMap = null (line 233)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

mixed $documentObject = null (line 239)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

mixed $dumpSQL = false (line 242)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

object An $errorHandler = null (line 189)

• var: error_handler for the modX instance.
• access: public

modEvent $event = null (line 108)

• var: The current event being handled by modX.
• access: public

array $jscripts = array () (line 179)

• var: An array of javascript content to be inserted into the BODY of an HTML resource.
• access: public

mixed $loadedjscripts = array () (line 180)

• access: public

array $placeholders = array () (line 125)

• var: An array of key=> value pairs that can be used by any Resource or Element.
• access: public

modRequest $request = null (line 76)

• var: Represents a web request and provides helper methods for dealing with request parameters and other attributes of a request.
• access: public

boolean $resourceGenerated = false (line 160)

• var: Indicates if the resource was generated during this request.
• access: public

array $resourceListing = null (line 95)

• var: A listing of site Resources and Context-specific meta data.
• access: public

string $resourceMethod = null (line 156)

• var: The method to use to locate the Resource, 'id' or 'alias'.
• access: public

array $sanitizePatterns = array(
'scripts' => '@<script[^>]*?>.*?</script>@si',
'entities' => '@&#(\d+);@e',
'tags' => '@\[\[(.[^\[\[]*?)\]\]@si',
) (line 193)

• var: An array of regex patterns regulary cleansed from content.
• access: public

array $sjscripts = array () (line 174)

• var: An array of javascript content to be inserted into the HEAD of an HTML resource.
• access: public

mixed $stopOnNotice = false (line 241)

• deprecated: 2006-09-15 To be removed in 2.1
• access: public

array $version = null (line 164)

• var: Version information for this MODx deployment.
• access: public

array $_config = null (line 205)

• var: A config array that stores the bootstrap settings.
• access: protected

mixed $_logSequence = 0 (line 214)

• access: protected

array $_systemConfig = null (line 209)

• var: A config array that stores the system-wide settings.
• access: public

static protect (line 250)

Harden the environment against common security flaws.

• access: public

static toQueryString (line 320)

Turn an associative array into a valid query string.

• return: A valid query string representing the parameters.
• access: public

• array $parameters: An associative array of parameters.

addEventListener (line 2503)

Add a plugin to the eventMap within the current execution cycle.

• return: true if the event is successfully added, otherwise false.
• access: public

• string $event: Name of the event.
• integer $pluginId: Plugin identifier to add to the event.

beforeRender (line 2699)

Executed before the response is rendered.

• access: public

changePassword (line 2187)

Change current user's password.

• return: true if successful, otherwise return error message.
• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• string $o: The old password.
• string $n: The new password.

checkForLocks (line 2629)

Checks for locking on a page.

• access: public

• integer $id: Id of the user checking for a lock.
• string $action: The action identifying what is locked.
• string $type: Message indicating the kind of lock being checked.

checkSession (line 1056)

Checks to see if the user has a session in the specified context.

• return: True if the user is valid in the context specified.
• access: public

• string $sessionContext: The context to test for a session key in.

cleanDocumentIdentifier (line 2203)

Cleans the document request parameter.

• deprecated: 2007-09-17 TO be removed in 2.1
• access: public

• string|integer $qOrig

getActiveChildren (line 1800)

Get all published children documents of the specified document.

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• $id
• $sort
• $dir
• $fields

getAuthenticatedUser (line 1034)

Gets the user authenticated in the specified context.

• access: public

• string $contextKey: Optional context key; uses current context by default.

getChildIds (line 552)

Gets all of the child resource ids for a given resource.

• return: An array of all the child resource ids for the specified resource.
• see: getTree for heirarchical node results
• access: public

• integer $id: The resource id for the starting node.
• integer $depth: How many levels max to search for children (default 10).

getConfig (line 1096)

Get the configuration for the site.

• return: An associate array of configuration key/values
• access: public

getDocGroups (line 2165)

Alias of getUserDocGroups().

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

getDocumentChildren (line 1831)

Get all children documents of the specified document.

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• $parentid
• $published
• $deleted
• $fields
• $where
• $sort
• $dir
• $limit

getDocumentIdentifier (line 2218)

Gets the identifier specifying a requested document.

• return: The requested document alias or id.
• deprecated: 2007-09-17 TO be removed in 2.1
• access: public

• string $method: 'id' or 'alias'.

getDocumentObject (line 1318)

Legacy call to set the current documentObject being handled by MODx.

• return: An associative array containing all the document data.
• deprecated: 0.9.7 - Jan 18, 2007
• access: public

• string $method: 'id' or 'alias' to indicate the lookup method.
• string|int $identifier: The identifier for looking up the document.

getEventMap (line 2585)

Gets a map of events and registered plugins for the specified context.

Service #s:

1. - Parser Service Events
2. - Manager Access Events
3. - Web Access Service Events
4. - Cache Service Events
5. - Template Service Events
6. - User Defined Events

• return: A map of events and registered plugins for each.
• access: public

• string $contextKey: Context identifier.

getKeywords (line 2360)

Gets keyword data associated with a document.

• return: An array of keyword data for the specified document.
• deprecated: 2009-11-01 To be removed in 2.1
• access: public

• integer $id: A document id, defaults to current document id.

getLoginUserName (line 1478)

Returns the current user name, for the current or specified context.

• return: The username of the current user.
• access: public

• string $context: The key of a valid modContext so you can retrieve the username from a different context than the current.

getManagerPath (line 2322)

Gets the URL for the 'mgr' context.

• return: The base URL of the 'mgr' context relative to the web server document root.
• deprecated: 2007-09-17 Use MODX_MANAGER_URL or modX->getOption('manager_url')
• access: public

getPageInfo (line 2099)

Gets data from a resource.

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• integer $pageid
• integer $active
• string $fields

getParentIds (line 526)

Gets all of the parent resource ids for a given resource.

• return: An array of all the parent resource ids for the specified resource.
• access: public

• integer $id: The resource id for the starting node.
• integer $height: How many levels max to search for parents (default 10).

getPlaceholder (line 710)

Get a placeholder value by key.

• return: The value of the requested placeholder, or an empty string if not located.
• access: public
• usedby: modPlaceholderTag - To retrieve the placeholder value.

• string $key: The key of the placeholder to a return a value from.

getRegisteredClientStartupScripts (line 1302)

Returns all registered startup CSS, JavaScript, or HTML blocks.

• return: The parsed HTML of the startup scripts.
• access: public

getResponse (line 1193)

Attempt to load the response handler class, if not already loaded.

• return: Returns true if a valid response handler object was loaded on this or any previous call to the function, false otherwise.
• access: public

• $string $class: The class name of the response class to load. Defaults to modResponse; is ignored if the Setting "modResponse.class" is set.
• $path $path: The absolute path by which to load the response class from. Defaults to the current MODx model path.

getSettings (line 1146)

Alias for getConfig().

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

getTemplateVarOutput (line 2022)

Gets an array of template variable data, with processed output.

• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• string|array $idnames
• integer $resourceId
• integer $published

getTree (line 579)

Get a site tree from a single or multiple modResource instances.

• return: An array containing the tree structure.
• see: getChildIds for linear results
• access: public

• int|array $id: A single or multiple modResource ids to build the tree from.
• int $depth: The maximum depth to build the tree (default 10).

getUserDocGroups (line 1725)

Returns an array of resource groups that current user is assigned to.

This function will first return the web user doc groups when running from frontend otherwise it will return manager user's resource group.

• return: An array of document group ids, names, false or empty string.
• deprecated: 2007-09-17 To be removed in 2.1
• access: public

• boolean $resolveIds: Set to true to return the resource group names.

getVersionData (line 1069)

Gets the modX core version data.

• return: The version data loaded from the config version file.
• access: public

handleRequest (line 1156)

Initialize, cleanse, and process a request made to a modX site.

• return: The result of the request handler.
• access: public

initialize (line 389)

Initializes the modX engine.

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

• access: public

• string $contextKey: Indicates the context to initialize.

invokeEvent (line 1335)

Invokes a specified Event with an optional array of parameters.

• todo: refactor this completely, yuck!!
• access: public
• usedby: modX::sendUnauthorizedPage() - The OnPageUnauthorized event is invoked before the unauthorized page is forwarded to.
• usedby: modX::sendErrorPage() - The OnPageNotFound event is invoked before the error page is forwarded to.

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

isFrontend (line 2482)

Indicates if modX is executing in a context other than mgr.

• return: true if the context is not 'mgr'.
• deprecated: 2007-09-15: Use the context key to identify a specific context.
• access: public

isMemberOfWebGroup (line 1526)

Determines if the current webuser is a member of the specified webgroups.

• return: True if the user is a member of any one of the supplied group names, false otherwise.
• deprecated: 2009-11-01 To be removed in 2.1
• access: public

• array $groupNames: An array of groups to check against.

logEvent (line 2272)

Add an a alert message to the system event log

• deprecated: 2007-09-17 TO be removed in 1.0
• access: public

• integer $evtid
• integer $type: 1 = information, 2 = warning, 3 = error.
• string $msg
• string $source: Default is 'Parser'.

makeUrl (line 767)

Generates a URL representing a specified resource.

• return: The URL for the resource.
• access: public

• integer $id: The id of a resource.
• string $context: Specifies a context to limit URL generation to.
• string $args: A query string to append to the generated URL.
• mixed $scheme: The scheme indicates in what format the URL is generated.
  

        -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

mergeDocumentContent (line 2406)

Processes document content tags.

• deprecated: 2007-09-17 To be removed in 2.1 - use modParser::processElementTags().
• access: public

• $content

mergeSettingsContent (line 2416)

Processes document setting tags (and placeholders).

• deprecated: 2007-09-17 To be removed in 2.1 - use modParser::processElementTags().
• access: public

• $content

parseChunk (line 1681)

Parse a chunk using an associative array of replacement variables.

• return: The processed chunk with the placeholders replaced.
• access: public

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

regClientCSS (line 1208)

Register CSS to be injected inside the HEAD tag of a resource.

• access: public

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

regClientScript (line 1251)

Register JavaScript to be injected before the closing BODY tag.

• access: public

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

regClientStartupScript (line 1228)

Register JavaScript to be injected inside the HEAD tag of a resource.

• access: public

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

removeAllEventListener (line 2461)

Remove all registered events for the current request.

• access: public

runProcessor (line 1422)

Loads and runs a specific processor.

• return: The result of the processor.
• access: public

• string $action: The processor to run, eg: context/update
• array $scriptProperties: Optional. An array of parameters to pass to the processor.
• array $options:

  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.)

sanitizeString (line 308)

Sanitizes a string

• return: The sanitized string.
• access: public

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

sendErrorPage (line 925)

Send the user to a MODx virtual error page.

• access: public
• uses: modX::invokeEvent() - The OnPageNotFound event is invoked before the error page is forwarded to.

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

sendRedirect (line 839)

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.

• access: public

• string $url: The URL to redirect the client browser to.
• array|boolean $options: 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).
• string $type: The type of redirection to attempt (deprecated, use type in options array).
• string $responseCode: The type of HTTP response code HEADER to send for the redirect (deprecated, use responseCode in options array)

setDebug (line 471)

Sets the debugging features of the modX instance.

• return: The previous value.
• access: public

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

xPDO::setDebug()

Sets the debug state for the XPDO connection.

setPlaceholders (line 627)

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.

• access: public

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

switchContext (line 2536)

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.

• return: True if the switch was successful, otherwise false.
• access: public

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

toPlaceholders (line 646)

Sets placeholders from values stored in arrays and objects.

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

• return: 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.
• access: public

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

unsetPlaceholders (line 735)

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

• access: public

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

_initContext (line 2733)

Loads a specified Context.

Merges any context settings with the modX::$config, and performs any other context specific initialization tasks.

• access: protected

• string $contextKey: A context identifier.

_initErrorHandler (line 2780)

Loads the error handler for this instance.

• access: protected

_initSession (line 2811)

Loads the session handler and starts the session.

• access: protected

_loadExtensionPackages (line 429)

Loads any specified extension packages

• access: protected

_logInRegister (line 2932)

Provides custom logging functionality for modRegister targets.

• access: protected

• $register
• $level
• $msg
• $def
• $file
• $line