MODx API

Документация по MODx API

addEventListener — Добавить обработчик события для плагина.

changePassword — Смена пароля для текущего веб-пользователя.

changeWebUserPassword — Смена пароля для текущего веб-пользователя.

clearCache — Очистка кэша сайта.

getActiveChildren — Возвращает информацию обо всех дочерних документах, которые являются опубликованными и не удалены.

getAllChildren — Возвращает информацию обо всех дочерних документах, включая неопубликованные и удаленные.

getCachePath — Возвращает относительный путь до папки для кэширования.

getChildIds — Возвращает массив дочерних документов, учитывая глубину.

getChunk — Получить содержимое чанка по названию.

getConfig — Возвращает системные параметры и соответствует вызову в шаблоне конструкции [(param)]

getDocGroups — Возвращает массив пользовательских групп, в которых текущий пользователь участвует.

getDocument — Получение информации о документе, с учетом дополнительных настроек.

getDocumentChildren — Возвращает список дочерних документов указанного документа, с учетом дополнительных настроек.

getDocumentChildrenTVarOutput — Получение списка дочерних документов, для указанного документа со значениями основных и дополнительных параметров, которые указаны.

getDocumentChildrenTVars — Получение списка дочерних документов, для указанного документа со значениями основных и дополнительных параметров, которые указаны.

getDocuments — Возвращает информацию для указанных документов, с учетом дополнительных настроек. По умолчанию возвращаются опубликованные документы, которые не удалены.

getFullTableName — Возвращает полное название таблицы с учетом префикса указанного в системных настройках.

getKeywords — Возвращает массив ключевых слов заданных для указанного документа.

getLoginUserID — Возвращает идентификатор авторизованного пользователя или NULL, если пользователь неавторизован.

getLoginUserName — Возвращает имя авторизованного пользователя или NULL, если пользователь неавторизован.

getLoginUserType — Возвращает текущий тип пользователя. Для менеджера возвращается manager, а для пользователя на сайте web.

getManagerPath — Возвращает относительный путь до директории менеджера.

getMETATags — Возвращает массив мета-тэгов заданных для указанного документа.

getPageInfo — Возвращает специальные данные по указанным полям.

getParent — Получение информации о родительском документе для указанного документа.

getParentIds — Возвращает массив родительских документов, учитывая заданное количество уровней.

getPlaceholder — Возвращает содержимое глобального плейсхолдера.

getSnippetId — Возвращает идентификатор текущего сниппета, в котором происходит вызов.

getSnippetName — Возвращает название текущего сниппета, в котором происходит вызов.

getTemplateVar — Получение определенного дополнительного TV-параметра для документа.

getTemplateVarOutput — Получение дополнительных TV-параметров для документа.

getTemplateVars — Получение дополнительных TV-параметров для документа.

getUserData — Возвращает информацию о клиентском системном окружении (браузер, операционная система и т.д.).

getUserDocGroups — Возвращает массив пользовательских групп, в которых текущий пользователь участвует.

getUserInfo — Получение информации о менеджере по заданному идентификатору.

getVersionData — Возвращает информацию о версии MODx.

getWebUserInfo — Получение информации о пользователе сайта по заданному идентификатору.

hasPermission — Проверка прав менеджера.

insideManager — Возвращает значения install (для функций установки модуля), interact (для основных функций управления) и true(для всех остальных функций) при нахождении в системе управления.

invokeEvent — Вызвать заданное событие.

isBackend — Если страница формируется в системе управления (backend), то функция возвращает true, иначе false.

isFrontend — Если страница формируется в пользовательской части (frontend), то функция возвращает true, иначе false.

isMemberOfWebGroup — Проверка принадлежности пользователя к указанным веб-группам. Если пользователь принадлежит хотя бы к одной из групп, то возвращается true, иначе false.

logEvent — Создает сообщение в системный лог.

makeList — Создает список по переданному массиву с учетом вложенности.

makeUrl — Создает абсолютный или относительный путь для указанного документа. При этом не проверяется существование или статус документа.

mapPath — Получение физического пути по указанному виртуальному.

parseChunk — Функция для вызова чанка с обработкой для замены плейсхолдеров на значения.

parseProperties — Разбирает строку конфигурации плагина или сниппета и возвращает текущие значения в виде массива.

putChunk — Устаревший метод идентичный getChunk(). Не рекомендуется использовать.

regClientCSS — Подключение файла стилей CSS к документу или блока <style> в область <head>.

regClientHTMLBlock — Размещение заданного HTML-кода в конец документа.

regClientScript — Подключение скриптов JavaScript или блока <script> в конец документа.

regClientStartupHTMLBlock — Размещение заданного кода HTML в область <head>.

regClientStartupScript — Подключение скриптов JavaScript к документу или блока <script> в область <head>.

removeAllEventListener — Удалить все обработчики событий.

removeEventListener — Удалить обработчик события для плагина.

runSnippet — Возвращает результат выполнения сниппета с заданными параметрами.

sendAlert — Отправить сообщение в ящик пользователя.

setPlaceholder — Устанавливает значение глобального плейсхолдера. MODx самостоятельно заменит затем встречающиеся плейсхолдеры в содержимом, которые были заданы.

stripTags — Удаление вызовов сниппетов, плейсхолдеров, чанков, TV-параметров и настроек, а также HTML-тегов из фрагмента HTML-кода, исключая список разрешенных тегов.

toPlaceholder — Задает значение плейсхолдера с учетом префикса.

toPlaceholders — Переводит массив или объект в набор плейсхолдеров.

userLoggedIn — Определяет, авторизован ли пользователь через систему администрирования MODx (как менеджер) или на сайте (как пользователь) и возвращает информацию о нем.

webAlert — Отображает сообщение alert с помощью JavaScript.

Рекламная информация