This document provides a cheat sheet for the DocParsers API in ModX Evolution version 1.0.2. It lists various objects, variables, functions, and events available through the API for interacting with documents, snippets, templates, and other system components. High-level areas covered include document parsing and manipulation, database interaction, template service events, and system events.

1. DocParsers API CHEATSHEET ed. 1.0 // ModX Evolution ver. 1.0.2 // released: 20091130, by goldsky
Document Parsers ($modx‐>)
aliases documentContent documentObject forwards queryCode sql
ariables chunkCache documentGenerated dumpSnippets jscripts queryTime stopOnNotice
config documentIdentifier dumpSQL loadedjscripts result table_prefix
Object va
contentTypes
t tT documentListing
d tLi ti entrypage
t maxParserPasses
P P rs templateObject
t l t Obj t
currentSnippet documentMap event minParserPasses sjscripts tstart
db documentMethod Event (=event) placeholders snippetCache virtualDir
debug documentName executedQueries pluginEvent snippetObjects visitor
addEventListener() getLoginUserID() getUserInfo() regClientHTMLBlock()
changeWebUserPassword() getLoginUserName() getVersionData() regClientScript()
clearCache() getLoginUserType() getWebUserInfo() regClientStartupHTMLBlock()
getActiveChildren() getManagerPath() hasPermission() regClientStartupScript()
getAllChildren() getMETATags() insideManager() removeAllEventListener()
getCachePath() getPageInfo() invokeEvent() removeEventListener()
API Functions
getChildIds() getParent() isBackend() runSnippet()
getChunk() getParentIds() isFrontend() sendAlert()
getConfig() getPlaceholder() isMemberOfWebGroup() setPlaceholder()
getDocument() getSnippetId() logEvent() stripTags()
getDocumentChildren() getSnippetName() makeList() toDateFormat()
getDocumentChildrenTVarOutput() getTemplateVar() makeUrl() toPlaceholder()
getDocumentChildrenTVars() getTemplateVarOutput() parseChunk() toPlaceholders()
tD
getDocuments()t () getTemplateVars()
tT l t V () parseProperties()
P ti () toTimeStamp()
t Ti St ()
getFullTableName() getUserData() putChunk() userLoggedIn()
getKeywords() getUserDocGroups() regClientCSS() webAlert()
evalPlugin() getMicroTime() mergeDocumentMETATags() prepareResponse()
her API Functions
evalSnippet() getRegisteredClientScripts() mergePlaceholderContent() rewriteUrls()
evalSnippets() getRegisteredClientStartupScripts() mergeSettingsContent() sendErrorPage()
executeParser() getSettings() messageQuit() sendForward()
getDocumentIdentifier() loadExtension() outputContent() sendRedirect()
getDocumentMethod() makeFriendlyURL() parseDocumentSource() sendUnauthorizedPage()
Oth
getDocumentObject() mergeChunkContent() phpError() stripAlias()
getFullTableName() mergeDocumentContent() postProcess()
($modx‐>db‐>)
Object Variables Object Functions getAffectedRows() getLastError() getVersion() prepareDate()
conn connect() getColumn() getRecordCount() getXML() query()
DB:API
config delete() getColumnNames() getRow() initDataTypes() select()
isConnected disconnect() getHTMLGrid() getTableMetaData() insert() update()
escape() getInsertId() getValue() makeArray()
Template Service Events OnManagerSaveUser OnDocDuplicate OnUserSettingsRender
OnDocPublished g
OnManagerWelcomePrerender OnDocFormPrerender OnInterfaceSettingsRender
g
OnLoadWebDocument OnBeforeManagerLogout OnDocFormSave OnSiteSettingsRender
OnParseDocument OnManagerAuthentication OnStripAlias Template Variables
OnWebPageInit OnManagerCreateGroup Modules OnBeforeTVFormDelete
OnDocUnPublished OnManagerLogin OnBeforeModFormDelete OnTVFormDelete
System Events ($modx‐>event() or $modx‐>invokeEvent())
OnLogPageHit OnManagerLoginFormRender OnModFormDelete OnTVFormRender
OnWebPageComplete OnManagerPageInit OnModFormRender OnBeforeTVFormSave
OnWebPagePrerender OnManagerWelcomeHome OnBeforeModFormSave OnTVFormPrerender
Cache Service Events OnManagerWelcomeRender OnModFormPrerender OnTVFormSave
OnBeforeCacheUpdate Parser Service Events
Parser Service Events OnModFormSave Templates
OnCacheUpdate OnFileManagerUpload Plugins OnBeforeTempFormDelete
OnBeforeSaveWebPageCache OnPageUnauthorized OnBeforePluginFormDelete OnTempFormDelete
OnLoadWebPageCache OnPageNotFound OnPluginFormDelete OnTempFormRender
Web Access Service Events OnSiteRefresh OnPluginFormRender OnBeforeTempFormSave
OnBeforeWebLogin Chunks OnBeforePluginFormSave OnTempFormPrerender
OnWebAuthentication OnBeforeChunkFormDelete OnPluginFormPrerender OnTempFormSave
OnWebCreateGroup OnChunkFormDelete OnPluginFormSave Users
OnWebLogin OnChunkFormRender RichText Editor OnBeforeUserFormDelete
OnBeforeWebLogout OnBeforeChunkFormSave OnRichTextEditorInit OnUserFormDelete
OnWebChangePassword OnChunkFormPrerender OnRichTextEditorRegister OnUserFormRender
OnWebDeleteUser OnChunkFormSave Snippets OnBeforeUserFormSave
OnWebLogout Documents OnBeforeSnipFormDelete OnUserFormPrerender
OnWebSaveUser OnBeforeDocDuplicate OnSnipFormDelete OnUserFormSave
Manager Access Events OnBeforeDocFormSave OnSnipFormRender Web Users
OnBeforeManagerLogin OnCreateDocGroup OnBeforeSnipFormSave OnBeforeWUsrFormDelete
OnBeforeManagerPageInit OnDocFormDelete OnSnipFormPrerender OnWUsrFormDelete
OnManagerChangePassword OnDocFormRender OnSnipFormSave OnWUsrFormRender
OnManagerDeleteUser OnEmptyTrash System Settings OnBeforeWUsrFormSave
OnManagerLoginFormPrerender OnBeforeDocFormDelete OnFriendlyURLSettingsRender OnWUsrFormPrerender
OnManagerLogout OnBeforeEmptyTrash OnMiscSettingsRender OnWUsrFormSave