API Functions

//Добавить обработчик события для плагина, используется только для текущего цикла выполнения. 			
$modx->addEventListener(string $evtName, string $pluginName);
//возникновении ошибок метод возвращает информацию об ошибке на английском языке.
$modx->changeWebUserPassword(string $oldPwd, string $newPwd);
//эта функция очищает не весь кэш.
$modx->clearCache();
//Возвращает информацию о дочерних документах только первого уровня.
$modx->getActiveChildren (mixed $id[, string $sort[, string $dir[, string $fields]]]);
//возвращает информацию о дочерних документах только первого уровня.
$modx->getAllChildren(mixed $id[, string $sort[, string $dir[, string $fields]]]);
//Возвращает относительный путь до папки для кэширования
$modx->getCachePath();
//Возвращает массив дочерних документов, учитывая глубину
$modx->getChildIds(mixed $id[, int $depth[, array $children]]);
//Получить содержимое чанка по названию
$modx->getChunk(string $chunkName);
//Cоответствует вызову в шаблоне конструкции [(param)]
$modx->getConfig(string $name);
//Получение информации о документе, с учетом дополнительных настроек
$modx->getDocument(int $id[, string $fields[, int $published[, int $deleted]]]);
//Возвращает список дочерних документов указанного документа, с учетом дополнительных настроек
$modx->getDocumentChildren (mixed $id[, int $active[, int $deleted[, string $fields[, string $where[, string $sort[, string $dir[, int $limit]]]]]]]);
//Получение списка дочерних документов, для указанного документа со значениями основных и дополнительных параметров, которые указаны
$modx->getDocumentChildrenTVars(int $parentid, array $tvidnames[, int $published[, string $docsort[, string $docsortdir]]]);
//Получение списка дочерних документов, для указанного документа со значениями основных и дополнительных параметров, которые указаны
$modx->getDocumentChildrenTVars(int $parentid, array $tvidnames[, int $published[, string $docsort[, string $docsortdir[,string $tvfields[, string $tvsort[, string $tvsortdir]]]]]]);
//Возвращает информацию для указанных документов, с учетом дополнительных настроек. По умолчанию возвращаются опубликованные документы, которые не удалены
$modx->getDocument(array $ids[, int $published[, int $deleted[, string $fields[, string $where[, string $sort[, string $dir[, string $limit]]]);
//Возвращает полное название таблицы с учетом префикса указанного в системных настройках
$modx->getFullTableName(string $tbl);
//Возвращает массив ключевых слов заданных для указанного документа(depricated)
$modx->getKeywords(int $id);
//Возвращает идентификатор авторизованного пользователя или NULL, если пользователь неавторизован
$modx->getLoginUserID();
//Возвращает имя авторизованного пользователя или NULL, если пользователь неавторизован
$modx->getLoginUserName();
//Возвращает текущий тип пользователя. Для менеджера возвращается manager, а для пользователя на сайте web
$modx->getLoginUserType();
//Возвращает относительный путь до директории менеджера
$modx->getManagerPath();
//Возвращает массив мета-тэгов заданных для указанного документа(depricated)
$modx->getMETATags(int $id);
//Возвращает специальные данные по указанным полям
$modx->getPageInfo (int $id[, int $published[, string $fields]]);
//Получение информации о родительском документе для указанного документа
$modx->getParent(int $id[, int $published[, string $fields]]);
//Возвращает массив родительских документов, учитывая заданное количество уровней
$modx->getParentIds(mixed $id[, int $height= 10[, array $parents= array ()]]);
//многие сниппеты имеют собственные плейсхолдеры, которые они обрабатывают самостоятельно. Метод getPlaceholder может о них ничего не знать.
$modx->getPlaceholder(string $name);
//Возвращает идентификатор текущего сниппета, в котором происходит вызов
$modx->getSnippetId();
//Возвращает название текущего сниппета, в котором происходит вызов
$modx->getSnippetName();
//Получение определенного дополнительного TV-параметра для документа
$modx->getTemplateVar(string $idname[, string $fields[, int $docid[, int $published]]]);
//Получение дополнительного TV-параметра для документа в формате вывода
$modx->getTemplateVarOutput(array $idnames[, int $docid[, int $published]]);
//Получение дополнительных TV-параметров для документа
$modx->getTemplateVars(array $idnames[, string $fields[, int $docid[, int $published[, string $sort[, string $dir]]]]]);
//Возвращает информацию о клиентском системном окружении (браузер, операционная система и т.д.)
$modx->getUserData();
//Возвращает массив пользовательских групп, в которых текущий пользователь участвует
$modx->getUserDocGroups([bool $resolveIds]);
//Получение информации о менеджере по заданному идентификатору
$modx->getUserInfo (int $uid);
//Возвращает информацию о версии EVO
$modx->getVersionData();
//Получение информации о пользователе сайта по заданному идентификатору
$modx->getWebUserInfo (int $uid);
//Проверка прав менеджера
$modx->hasPermission(string $pm);
//Возвращает значения install, interact и true при нахождении в системе управления(deprecated)
$modx->insideManager();
//Вызвать заданное событие
$modx->invokeEvent(string $evtName, array $extParams);
//Если страница формируется в системе управления (backend), то функция возвращает true, иначе false
$modx->isBackend();
//Если страница формируется в пользовательской части (frontend), то функция возвращает true, иначе false
$modx->isFrontend();
//Проверка принадлежности пользователя к указанным веб-группам.
$modx->isMemberOfWebGroup(array $groupNames);
//Создает сообщение в системный лог
$modx->logEvent(int $evtid, int $type, string $msg [, $source= 'Parser']);
//Создает список по переданному массиву с учетом вложенности
$modx->makeUrl(int $array[, string $ulroot[, string $ulprefix[, string $type[, bool $ordered[, int $tablevel]]]]]);
//Создает абсолютный или относительный путь для указанного документа. При этом не проверяется существование или статус документа
$modx->makeUrl(int $id[, mixed $alias[, mixed $args[, mixed $scheme]]]);
//Функция для вызова чанка с обработкой для замены плейсхолдеров на значения
$modx->parseChunk(string $chunkName, array $chunkArr[, string $prefix[, string $suffix]]);
//Разбирает строку конфигурации плагина или сниппета и возвращает текущие значения в виде массива
$modx->parseProperties(string $propertyString);
//Подключение файла стилей CSS к документу или блока ‹style› в область ‹head›
$modx->regClientCSS(string $src[, string $media]);
//Размещение заданного HTML-кода в конец документа
$modx->regClientHTMLBlock(string $html);
//Подключение скриптов JavaScript или блока ‹script› в конец документа
$modx->regClientScript(string $src[, bool $plaintext]);
//Размещение заданного кода HTML в область ‹head›
$modx->regClientStartupHTMLBlock(string $html);
//Подключение скриптов JavaScript к документу или блока ‹script› в область ‹head›
$modx->regClientStartupScript(string $src[, bool $plaintext]);
//Удалить все обработчики событий
$modx->removeAllEventListener();
//Удалить обработчик события для плагина
$modx->removeEventListener(string $evtName);
//Возвращает результат выполнения сниппета с заданными параметрами
$modx->runSnippet(string $snippetName [, array $params]);
//Отправить сообщение в ящик пользователя
$modx->sendAlert(string $type, mixed $to, mixed $from, string $subject, string $msg[, int $private]);
//Устанавливает значение глобального плейсхолдера. MODx самостоятельно заменит затем встречающиеся плейсхолдеры в содержимом, которые были заданы
$modx->setPlaceholder(string $name, string $value);
//Удаление вызовов сниппетов, плейсхолдеров, чанков, TV-параметров и настроек, а также HTML-тегов из фрагмента HTML-кода, исключая список разрешенных тегов
$modx->stripTags(string $html[, string $allowed]);

$modx->toDateFormat()

//Задает значение плейсхолдера с учетом префикса
$modx->toPlaceholders(string $key, string $value[, string $prefix]);
//Переводит массив или объект в набор плейсхолдеров
$modx->toPlaceholders(mixed $subject[, string $prefix]);

$modx->toTimeStamp()

//Определяет, авторизован ли пользователь
$modx->userLoggedIn();
//Отображает сообщение alert с помощью JavaScript
$modx->webAlert(string $msg[, $url]);

			

Other API Functions

$modx‐>evalPlugin()
$modx‐>evalSnippet()
$modx‐>evalSnippets()
$modx‐>executeParser()
$modx‐>getDocumentIdentifier
$modx‐>getDocumentMethod()
$modx‐>getDocumentObject()
$modx‐>getFullTableName()
$modx‐>getMicroTime()
$modx‐>getRegisteredClientScripts()
$modx‐>getRegisteredClientStartupScripts()
$modx‐>getSettings()
$modx‐>loadExtension()
$modx‐>makeFriendlyURL()
$modx‐>mergeChunkContent()
$modx‐>mergeDocumentContent()
$modx‐>mergeDocumentMETATags()
$modx‐>mergePlaceholderContent()
$modx‐>mergeSettingsContent()
$modx‐>messageQuit()
$modx‐>outputContent()
$modx‐>parseDocumentSource()
$modx‐>phpError()
$modx‐>postProcess()
$modx‐>prepareResponse()
$modx‐>rewriteUrls()
$modx‐>sendErrorPage()
$modx‐>sendForward()
$modx‐>sendRedirect()
$modx‐>sendUnauthorizedPage()
$modx‐>stripAlias()

			

Object variables

$modx‐>aliases
$modx‐>chunkCache
//Системные настройки
$modx->config['modx_charset'];
$modx‐>contentTypes
$modx‐>currentSnippet
$modx‐>db
$modx‐>debug
//Содержит полное содержимое страницы. 
$modx‐>documentContent;
//Страница была сгенерирована или из кеша
$modx‐>documentGenerated;
//Идентификатор текущего ресурса
$modx‐>documentIdentifier;
//Массив соответствия псевдонима и идентификатора русурса
$modx->documentListing['index']; 
$modx‐>documentMap
//Метод получения ресурса
$modx‐>documentMethod;
$modx‐>documentName
//Содержит полный набор данных для текущей страницы в виде ассоциативного массива. 
$modx->documentObject['pagetitle']; 
$modx‐>dumpSnippets
$modx‐>dumpSQL
$modx‐>entrypage
$modx‐>event
$modx‐>executedQueries
$modx‐>forwards
$modx‐>jscripts
$modx‐>loadedjscripts
//Максимальное количество проходов парсера
$modx‐>maxParserPasses;
//Минимальное количество проходов парсера
$modx‐>minParserPasses;
$modx‐>placeholders
$modx‐>pluginEvent
$modx‐>queryCode
$modx‐>queryTime
$modx‐>result
$modx‐>rs
$modx‐>sjscripts
$modx‐>snippetCache
$modx‐>snippetObjects
$modx‐>sql
$modx‐>stopOnNotice
$modx‐>table_prefix
$modx‐>templateObject
//Время начала работы MODX
$modx‐>tstart;
$modx‐>virtualDir
$modx‐>visitor