DocumentParser ($modx)

The DocumentParser class is the core of the MODx page rendering framework. The DocumentParser object can be accessed with the global $modx from Snippets, Modules, and Plugins.

To see what the $modx variable contains when your script is run, try putting this in to your script:

<?php
die(print_r($modx,true));
?>

WARNING! That command will output a large amount of data to your browser, it also should not be executed on live sites as doing so reveals your database password. Use at your own risk! Also keep in mind that the $modx contains your database username and password and executing the line above will expose those credentials.

Members

• [table_prefix]
• [documentIdentifier]
• [documentMethod]
• [documentGenerated]
• [documentContent]
• [tstart]
• [minParserPasses]
• [maxParserPasses]
• [documentObject]
• [templateObject]
• [snippetObjects]
• [stopOnNotice]
• [executedQueries]
• [queryTime]
• [currentSnippet]
• [documentName]
• [aliases]
• [visitor]
• [entrypage]
• [documentListing]
• [dumpSnippets]
• [chunkCache]
• [snippetCache]
• [contentTypes]
• [dumpSQL]
• [queryCode]
• [virtualDir]
• [placeholders]
• [sjscripts]
• [loadedjscripts]
• [jscripts]
• [documentMap]

Methods

• [getParentIds]
• [getChildIds]
• [webAlert]
• [hasPermission]
• [logEvent]
• [isBackend]
• [isFrontend]
• [getAllChildren]
• [getActiveChildren]
• [getDocumentChildren]
• [getDocuments]
• [getDocument]
• [getPageInfo]
• getParent
• [getSnippetId]
• [getSnippetName]
• [clearCache]
• [makeUrl]
• [getConfig]
• [getVersionData]
• [makeList]
• [userLoggedIn]
• [getKeywords]
• [getMETATags]
• [runSnippet]
• [getChunk]
• [putChunk]
• [parseChunk]
• [getUserData]
• [getDocumentChildrenTVars]
• [getDocumentChildrenTVarOutput]
• [getTemplateVar]
• [getTemplateVars]
• [getTemplateVarOutput]
• [getFullTableName]
• [mapPath]
• [getPlaceholder]
• [setPlaceholder]
• [getManagerPath]
• [getCachePath]
• [sendAlert]
• [insideManager]
• [getLoginUserID]
• [getLoginUserName]
• [getLoginUserType]
• [getUserInfo]
• [getWebUserInfo]
• [getUserDocGroups]
• [getDocGroups]
• [changeWebUserPassword]
• [changePassword]
• [isMemberOfWebGroup]
• [regClientCSS]
• [regClientStartupScript]
• [regClientScript]
• [regClientStartupHTMLBlock]
• [regClientHTMLBlock]
• [stripTags]
• [addEventListener]
• [removeEventListener]
• [removeAllEventListener]
• [invokeEvent]
• [parseProperties]

Other functions

• [affectedRows]
• [checkCache]
• [checkPreview]
• [checkPublishStatus]
• [checkSession]
• [checkSiteStatus]
• [cleanDocumentIdentifier]
• [dbClose]
• [dbConnect]
• [dbQuery]
• [evalPlugin]
• [evalSnippet]
• [evalSnippets]
• [executeParser]
• [fetchRow]
• [getDocumentIdentifier]
• [getDocumentMethod]
• [getDocumentObject]
• [getMicroTime]
• [getRegisteredClientScripts]
• [getRegisteredClientStartupScripts]
• [getSettings]
• [insertId]
• [loadExtension]
• [makeFriendlyURL]
• [mergeChunkContent]
• [mergeDocumentContent]
• [mergeDocumentMETATags]
• [mergePlaceholderContent]
• [mergeSettingsContent]
• [messageQuit]
• [outputContent]
• [parseDocumentSource]
• [phpError]
• [postProcess]
• [prepareResponse]
• [recordCount]
• [rewriteUrls]
• [sendErrorPage]
• [sendForward]
• [sendRedirect]
• [sendUnauthorizedPage]