Русский English Український

    Edit

    Події плагінів

    Template Service Events

    Всі події, пов'язані з відображенням сторінки

    OnBeforeLoadDocumentObject

    Запускається перед формуванням $modx->documentObject.

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    method - метод доступу до документа
identifier - ідентифікатор документа

    OnLoadDocumentObject

    Запускається при формуванні $modx->documentObject

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    method - метод доступу до документа
identifier - ідентифікатор документа
documentObject - об'єкт поточного документа

    OnAfterLoadDocumentObject

    Запускається після формування $modx->documentObject. Від OnLoadDocumentObject відрізняється тим, що містить у собі tv поля поточного документа.

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    method - метод доступу до документа
identifier - ідентифікатор документа
documentObject - об'єкт поточного документа

    OnBeforeLoadExtension

    Запускається перед підвантаженням розширення.

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    name - ім'я підвантаженням розширення
reload - прапорець який відображає, чи була запрошена перепідгрузка

    OnBeforeParseParams

    Запускається перед парсингом параметрів у виклику сніпета.

    manager/includes/document.parser.class.inc.php

    OnDocPublished

    Запускається при публікації документа

    manager/processors/publish_content.processor.php

    Доступні змінні:

    docid - id документа

    OnDocUnPublished

    Запускаєтся при знятті документа з публікації

    manager/processors/unpublish_content.processor.php

    Доступні змінні:

    docid - id документа

    OnLoadWebDocument

    Запускається, якщо документ був взятий з бази

    manager/includes/document.parser.class.inc.php

    OnLogPageHit

    Запускається, якщо стоїть налаштування "Відстежувати відвідування". Ця подія викликається перед завантаженням документа.

    manager/includes/document.parser.class.inc.php

    OnMakeDocUrl

    Запускається після формування url через функцію $modx->makeUrl(), або теги [~...~]. 

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    id - id документа
url - сформований url

    OnParseDocument

    Запускається перед тим, як будуть оброблені ТВ, сніпети і чанки

    manager/includes/document.parser.class.inc.php

    OnParseProperties

    Запускаєтся при парсингу рядки параметрів ресурсу.

    manager/includes/document.parser.class.inc.php

    Повертає:

    element -ім'я елемента
type - тип елемента
args - масив в форматі ім'я параметра => значення

    OnWebPageComplete

    Запускаєтся, коли сторінка повністю сформована. Після кешування документа.

    manager/includes/document.parser.class.inc.php

    OnWebPageInit

    Подія викликається при ініцілізаціі сторінки. Виконується одним з перших. Якщо сторінка була закешована раніше, то запускається після того, як кеш буде завантажений в $modx.

    manager/includes/document.parser.class.inc.php

    OnWebPagePrerender

    Запускаєтся перед тим, як сторінка буде віддана клієнту. Це остання подія, викликане до того, як сторінка буде відправлена в клієнтський браузер.

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    documentOutput - вміст сторінки

    Cache Service Events

    Події кешування

    OnBeforeCacheUpdate

    Запускається перед оновленням кешу

    manager/processors/cache_sync.class.processor.php

    OnBeforeSaveWebPageCache

    Запускається після збереження сторінки в кеші

    manager/includes/document.parser.class.inc.php

    OnCacheUpdate

    Запускається відразу після запису в кеш

    manager/processors/cache_sync.class.processor.php

    OnLoadWebPageCache

    Запускається після завантаження кешованої сторінки

    manager/includes/document.parser.class.inc.php

    OnMakePageCacheKey

    Запускається після формування ключа для кешу сторінки.

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    hash - ключ кеша сторінки
id - id кэшируемого документа
params - відсортовані GET параметри поточного запиту

    Web Access Service Events

    Події, пов'язані з авторизацією і редагування веб-користувача

    OnBeforeWebLogin

    Запускається перед тим, як веб-користувач авторизирується.

    Може бути викликано різними сніпетами авторизації. Наприклад WebLogin:
assets/snippets/weblogin/weblogin.processor.inc.php

    Доступні змінні:

    username - ім'я користувача
userpassword - пароль
rememberme - запам'ятати чи ні користувача

    OnBeforeWebLogout

    Може бути викликано різними сніпетами авторизації. Наприклад WebLogin:
assets/snippets/weblogin/weblogin.processor.inc.php

    Доступні змінні:

    userid - id
username - ім'я користувача

    OnWebAuthentication

    Може бути викликано різними сніпетами авторизації. Наприклад WebLogin:
assets/snippets/weblogin/weblogin.processor.inc.php

    OnWebChangePassword

    manager/includes/document.parser.class.inc.php
manager/processors/save_web_user.processor.php

    OnWebCreateGroup

    manager/processors/web_access_groups.processor.php

    OnWebDeleteUser

    manager/processors/delete_web_user.processor.php

    OnWebLogin

    Запускається при авторизації веб-користувача.

    Може бути викликано різними сніпетами авторизації. Наприклад WebLogin:
assets/snippets/weblogin/weblogin.processor.php

    Доступні змінні:

    userid - id користувача
username - ім'я користувача
userpassword - пароль
rememberme - запам'ятати чи ні

    OnWebLogout

    Може бути викликано різними сніпетами авторизації. Наприклад WebLogin:
assets/snippets/weblogin/weblogin.processor.inc.php

    Доступні змінні:

    userid - id користувача
username - ім'я користувача

    OnWebSaveUser

    Запускається при збереженні профіля користувача

    manager/processors/save_web_user.processor.php

    Доступні змінні:

    Якщо створення користувача:
mode - "new"
userid - id користувача
username - ім'я користувача
userpassword - пароль
useremail - пошта
userfullname - повне ім'я

Якщо редагування користувача:

mode - "upd"
userid id користувача
username - ім'я користувача
userpassword - пароль
useremail - пошта
userfullname - повне ім'я
oldusername - старе ім'я користувача
olduseremail - старий email

    Manager Access Events

    OnBeforeManagerLogin

    OnBeforeManagerLogout

    OnBeforeManagerPageInit

    OnManagerAuthentication

    OnManagerChangePassword

    OnManagerCreateGroup

    OnManagerDeleteUser

    OnManagerFrameLoader

    OnManagerLogin

    OnManagerLoginFormPrerender

    Подія запускається перед генерацією форми входу в панель адміністрування (форми авторизації). Може використовуватися для кастомізації сторінки входу і самої форми авторизації.

    OnManagerLoginFormRender

    Подія запускається після генерації форми входу в панель адміністрування (форми авторизації). Може використовуватися для кастомізації сторінки входу і форми авторизації.

    OnManagerLogout

    OnManagerMainFrameHeaderHTMLBlock

    OnManagerMenuPrerender

    OnManagerNodePrerender

    OnManagerNodeRender

    OnManagerPageInit

    OnManagerPreFrameLoader

    OnManagerSaveUser

    OnManagerTopPrerender

    OnManagerTreeInit

    OnManagerTreePrerender

    OnManagerTreeRender

    OnManagerWelcomeHome

    OnManagerWelcomePrerender

    OnManagerWelcomeRender

    Parser Service Events

    OnFileManagerUpload

    Запускається після завантаження файлу через вбудований файл-менеджер

    manager/actions/files.dynamic.php

    Доступні змінні:

    $filepath - шлях до файлу
$filename - ім'я файлу

    OnPageNotFound

    Запускається, якщо сторінка не знайдена. Найчастіше використовується для написання свого роутінга.

    manager/includes/document.parser.class.inc.php

    OnPageUnauthorized

    manager/includes/document.parser.class.inc.php

    OnSiteRefresh

    manager/actions/refresh_site.dynamic.php

    Chunks

    OnBeforeChunkFormDelete

    OnBeforeChunkFormSave

    OnChunkFormDelete

    OnChunkFormPrerender

    OnChunkFormRender

    OnChunkFormSave

    Documents

    OnAfterMoveDocument

    Подія, відпрацьовується ПІСЛЯ переміщення документа в інший батьківський в адміністративній панелі

    manager/processors/move_document.processor.php

    Доступні змінні:

    $id_document - id документа, який переноситься
$old_parent - id батьківського документа З якого перенесли документ
$new_parent - id батьківського документа КУДИ перенесли документ

    OnBeforeDocDuplicate

    Подія, відпрацьовується ДО створення дубліката документа в адміністративній панелі

    manager/processors/duplicate_content.processor.php

    Доступні змінні:

    $id - id документа, який переноситься

    OnBeforeDocFormDelete

    Подія, відпрацьовується ДО видалення (вказівка на видалення) документа в адміністративній панелі

    manager/processors/delete_content.processor.php

    Доступні змінні:

    $id - id документа, який видаляється
$children - масив нащадків документа, який видаляється

    Можна використовувати для перенесення дочірніх документів, що володіють якимись спеціальними властивостями в папку "архів"

    OnBeforeDocFormSave

    Подія, відпрацьовується ДО збереження документа в адміністративній панелі

    manager/processors/save_content.processor.php

    Доступні змінні:

    $mode - приймає значення new для нового документа, upd при оновленні документа
$id - id документа

    OnBeforeEmptyTrash

    Подія, відпрацьовується ДО очищення кошика в адміністративній панелі

    manager/processors/remove_content.processor.php

    Доступні змінні:

    $ids - масив, що містить id документи, позначених для видалення

    OnBeforeMoveDocument

    Подія, відпрацьовується ДО переміщення документа в інший батький документ в адміністративній панелі

    manager/processors/move_document.processor.php

    Доступні змінні:

    $id_document - id документа, що переноситься
$old_parent - id батьківського документа, ЗВІДКИ переносять докумет
$new_parent - id батьківського документа, КУДИ переносять докумет

    OnCreateDocGroup

    Подія відпрацьовується при створенні групи документів

    manager/processors/access_groups.processor.php
manager/processors/web_access_groups.processor.php

    Доступні змінн $id - id групи $newgroup - ім'я групи

    OnDocDuplicate

    Подія, відпрацьовується ПІСЛЯ створення дубліката документа в адміністративній панелі

    manager/processors/duplicate_content.processor.php

    Доступні змінні:

    $id - id документа, що переноситься
$new_id - id нового батьківського документа

    Використовується для зміни різних властивостей документа після створення дубліката (наприклад можна зробити лічильник кількості дублів)

    OnDocFormDelete

    Подія, відпрацьовується ПІСЛЯ видалення (вказівка на видалення) документа в адміністративній панелі

    manager/processors/delete_content.processor.php

    Доступні змінні:

    $id - id видаленого документа
$children - масив нащадків видаленого документа

    Можна використовувати, наприклад, для автоматичного, безповоротного видалення документів з таблиці (при цьому не варто забувати, що потрібно видаляти і ТБ параметри пов'язані з документами).

    OnDocFormPrerender

    Подія, відпрацьовується після відкриття форми редагування докуменда в адміністративній панелі

    manager/actions/mutate_content.dynamic.php

    Доступні змінні:

    $id - id документа
$template - id шаблона, який використовує поточний документ

    OnDocFormRender

    Подія, відпрацьовується після відкриття форми редагування докуменда в адміністративній панелі

    manager/actions/mutate_content.dynamic.php

    Доступні змінні:

    $id - id документа
$template - id шаблона, який використовує поточний документ

    OnDocFormSave

    Подія, відпрацьовується при збереженні документа в адміністративній панелі

    manager/processors/save_content.processor.php

    Доступні змінні:

    $mode - приймає значення new для нового документа, upd при оновленні документа
$id - id документа
global $tmplvars,$content // масиви, в яких містяться поля документа і ТВ-параметри

    OnDocFormTemplateRender

    Подія виникають при визначенні шаблону документа. Може використовуватися при зміні шаблону документа (наприклад підтягувати специфічні властивості)

    manager/actions/mutate_content.dynamic.php

    Доступні змінні:

    $id - id шаблона документа

    OnDocFormUnDelete

    Подія, відпрацьовується після відновлення документа з видалених в адміністративній панелі

    manager/processors/undelete_content.processor.php

    Доступні змінні:

    $id - id відновленого документа
$children - масив дочірніх документів відновленого документа

    OnEmptyTrash

    Подія, відпрацьовується ПІСЛЯ очищення кошика в адміністративній панелі

    manager/processors/remove_content.processor.php

    Доступні змінні:

    $ids - масив, який містить id документи, помічених для видалення

    OnStripAlias

    Подія яка запускається для очищення аліасу від недопустимих символів

    manager/includes/document.parser.class.inc.php

    Доступні змінні:

    $alias - псевдонім

    File Browser Events

    Події файлового браузера.

    OnFileBrowserInit

    Викликається після завантаження налаштувань файлового браузера. Налаштування можна замінити безпосередньо в змінній $config.

    OnBeforeFileBrowserUpload

    Викликається після того, як файл був завантажений на сервер в тимчасову папку, але до переміщення файлу в місце призначення. Якщо з плагіна повернути повідомлення, то файл буде видалено.

    Доступні змінні:

    $filepath - шлях, по якому буде завантажено файл
$file - посилання на масив з інформацією про файл

    OnFileBrowserUpload

    Викликається після того, як файл був завантажений на сервер і переміщений в місце призначення.

    Доступні змінні:

    $filepath - шлях, по якому був завантажено файл
$filename - ім'я файлу

    OnBeforeFileBrowserDelete

    Викликається перед видаленням файлу. Якщо з плагіна повернути повідомлення, то видалення буде перервано.

    $element - тип елемента, який видаляється (file або dir)
$filepath - шлях до файлу (тип file) або директорії (тип dir)
$filename - (тільки для file)

    OnFileBrowserDelete

    Викликається після видалення файлу.

    Доступні змінні:

    $element - тип елемента, який видаляється (file або dir)
$filepath - шлях до файлу (тип file) або директорії (тип dir)
$filename - ім'я файлу (тілько для file)

    OnBeforeFileBrowserMove

    Викликається перед переміщенням файлу. Якщо з плагіна повернути повідомлення, то переміщення буде перервано.

    Доступні змінні:

    $oldpath - вихідний шлях до файлу, включаючи ім'я файлу
$filename - ім'я файлу
$newpath - кінцевий шлях до файлу

    OnFileBrowserMove

    Викликається післе переміщення файлу.

    Доступні змінні:

    $oldpath - вихідний шлях до файлу, включаючи ім'я файлу
$filename - ім'я файлу
$newpath - кінцевий шлях до файлу

    OnBeforeFileBrowserCopy

    Викликається перед копіюванням файлу. Якщо з плагіна повернути повідомлення, то копіювання буде перервано.

    Доступні змінні:

    $oldpath - вихідний шлях до файлу, включаючи ім'я файлу
$filename - ім'я файлу
$newpath - кінцевий шлях до файлу

    OnFileBrowserCopy

    Викликається післе копіювання файлу.

    Доступні змінні:

    $oldpath - вихідний шлях до файлу, включаючи ім'я файлу
$filename - ім'я файлу
$newpath - шлях до файлу

    OnBeforeFileBrowserRename

    Викликається перед перейменуванням файлу або директорії.

    Доступні змінні:

    $element - тип елемента, який видаляється (file або dir)
$filepath - шлях до файлу (тип file) або директорії (тип dir)
$filename - ім'я файла (тільки для file)
$newname - нове ім'я (якщо змінити змінну, то зміниться і ім'я)

    OnFileBrowserRename

    Викликається після перейменування файлу або директорії.

    Доступні змінні:

    $element - тип елемента, який видаляється (file або dir)
$filepath - шлях до файлу (тип file) або директорії (тип dir)
$filename - ім'я файлу (тільки для file)
$newname - нове ім'я

    Modules

    OnBeforeModFormDelete

    OnBeforeModFormSave

    OnModFormDelete

    OnModFormPrerender

    OnModFormRender

    OnModFormSave

    Plugins

    OnBeforePluginFormDelete

    OnBeforePluginFormSave

    OnPluginFormDelete

    OnPluginFormPrerender

    OnPluginFormRender

    OnPluginFormSave

    RichText Editor

    OnRichTextEditorInit

    Запускається при ініціалізації текстового редактора

    manager/actions/mutate_content.dynamic.php
manager/actions/mutate_htmlsnippet.dynamic.php
manager/includes/tmplvars.format.inc.php

    Доступні змінні:

    $editor - назва активного редактора з OnRichTextEditorRegister
$elements - Ім'я <textarea> де працює редактор

    OnRichTextEditorRegister

    Дозволяє зареєструвати свій текстовий редактор для списку вибору редакторів.

    manager/actions/mutate_content.dynamic.php
manager/actions/mutate_htmlsnippet.dynamic.php
manager/actions/mutate_settings.dynamic.php
manager/actions/mutate_tmplvars.dynamic.php
manager/actions/mutate_user.dynamic.php

    Доступні змінні:

    $forfrontend - якщо редактор використовується для редагування на фронтенді, буде 1. Інакше 0.

    Приклад

    $e = &$modx->Event; 
switch ($e->name) {
    case "OnRichTextEditorRegister": // register the name
        $e->output("My RTE");
        break;

    case "OnRichTextEditorInit": // Initialize the editor
        if($editor == "My RTE") {
            // The editor is active
            $elementList = implode(",", $elements); // Comma-separated list of elements

            $html = "<!-- Add all the necessary code here -->";         

            $e->output($html);
        }       
        break;
}

    Snippets

    OnBeforeSnipFormDelete

    OnBeforeSnipFormSave

    OnSnipFormDelete

    OnSnipFormPrerender

    OnSnipFormRender

    OnSnipFormSave

    System Settings

    Події пов'язані з редагуванням системних налаштуваннь

    OnFriendlyURLSettingsRender

    Подія виникає після відкриття вкладки дружні URL в системній конфігурації

    manager/actions/mutate_settings/tab2_furl_settings.inc.php

    OnInterfaceSettingsRender

    Подія виникає після відкриття вкладки інтерфейс і уявлення в системній конфігурації і редагуванні користувача

    manager/actions/mutate_settings/tab4_manager_settings.inc.php
manager/actions/mutate_user.dynamic.php

    OnMiscSettingsRender

    OnSiteSettingsRender

    Подія виникає після відкриття вкладки *сайт в системній конфігурації

    manager/actions/mutate_settings/tab1_site_settings.inc.php

    OnUserSettingsRender

    Подія виникає після відкриття вкладки користувачі в системній конфігурації

    manager/actions/mutate_settings/tab3_user_settings.inc.php

    Template Variables

    Події пов'язані з редагуванням тв-параметрів

    OnBeforeTVFormDelete

    OnBeforeTVFormSave

    OnTVFormDelete

    OnTVFormPrerender

    OnTVFormRender

    OnTVFormSave

    Templates

    Події пов'язані з редагуванням шаблонів

    OnBeforeTempFormDelete

    OnBeforeTempFormSave

    OnTempFormDelete

    OnTempFormPrerender

    OnTempFormRender

    OnTempFormSave

    Users

    Події пов'язані з редагуванням менеджерів Увага! Users - це менеджери (адміністратори, редактори), т.п. ті, які авторизуйтесь через бек сайту і мають доступ до адміністративної частини сайту

    OnBeforeUserFormDelete

    Запускається ДО видалення менеджера

    manager/processors/delete_user.processor.php

    Доступныі змінні:

    $id - id менеджера

    OnBeforeUserFormSave

    Запускається до збереження менеджера

    manager/processors/save_user.processor.php

    Доступні змінні:

    $mode - приймає два значення: new (новий) і upd (оновлення)
id - id менеджера, використовується при $mode=='upd'

    OnUserFormDelete

    Запускаєтся після видалення менеджера

    manager/processors/delete_user.processor.php

    Доступні змінні:

    $id - id менеджера

    OnUserFormPrerender

    Запускається перед відображенням форми редагуванням менеджера

    manager/actions/mutate_user.dynamic.php

    Доступні змінні:

    $id - id менеджера

    OnUserFormRender

    Запускається після відображення форми редагування менеджера

    manager/actions/mutate_user.dynamic.php

    Доступні змінні:

    $id - id менеджера

    OnUserFormSave

    Запускаєтся післе збереження менеджера

    manager/processors/save_user.processor.php

    Доступні змінні:

    $mode - приймає два значення: new (новий) і upd (оновлення)
id - id менеджера

    Web Users

    Події пов'язані з редагуванням веб-користувачів Увага! Web Users - це веб-користувачі, тобто ті, які авторизуються через фронт сайту і не мають доступу до адміністративної частини сайту

    OnBeforeWUsrFormDelete

    Запускається ДО видалення веб-користувача 

    manager/processors/delete_web_user.processor.php

    Доступні змінні:

    $id - id користувача

    OnBeforeWUsrFormSave

    Запускається перед збереженням веб-користувача

    manager/processors/save_web_user.processor.php

    Доступні змінні:

    $mode - приймає два значення: new (новий) і upd (оновлений)
id - id користувача, використовується при $mode=='upd'

    OnWUsrFormDelete

    Запускається ПІСЛЯ видалення веб-користувача 

    manager/processors/delete_web_user.processor.php

    Доступні змінні:

    id - id користувача

    OnWUsrFormPrerender

    Запускається перед відображенням форми редагування веб-користувача

    manager/actions/mutate_web_user.dynamic.php

    Доступні змінні:

    $id - id користувача

    OnWUsrFormRender

    Запускається при відображенні форми редагування веб-користувача

    manager/actions/mutate_web_user.dynamic.php

    Доступні змінні:

    $id - id користувача

    OnWUsrFormSave

    Запускається після збереженням веб-користувача

    manager/processors/save_web_user.processor.php

    Доступні змінні:

    $mode - приймає два значення: new (новий) і upd (оновлений)
$id - id користувача