Что такое Плагины?

06.11.2023

Все плагины в CMS Zion WebEngine служат для выполнения каких-либо целей. Это может быть вывод какого-то текста, корректировка базы данных, изменение глобальных переменных и т.д.

Где хранятся плагины

Плагины могут быть самостоятельными программными модулями или могут быть частью классов

  • Каждый самостоятельный плагин хранится в одном из файлов в папке plugins, либо plugins/custom. Если Вы хотите изменить один из таких плагинов или создать новый, то сохраняйте его в папке plugins/custom - так он не будет заменён стандартным плагинов в случае обновления CMS. При совпадении имён в plugins и в plugins/custom наибольший приоритет имеют плагины из папки plugins/custom.
  • Если плагин является частью класса, то найти его можно в файле соответствующего класса. Это будет отдельный метод, имя которого всегда начинается с Plugin и в качестве параметров к которому должен передаваться массив params

Набор доступных плагинов зависит от комплекта поставки

Имена плагинов

  • Если плагин хранится в отдельном файле с имением мойплагин.php то имя плагина будет мойплагин (.php обязательно должно присутствовать в имени файла)
  • Если плагин является частью класса, например, мойкласс, и хранится в методе PluginМойПлагин, то имя плагина будет мойкласс_МойПлагин

К плагинам можно обращаться через команду вызова, через URL-адрес или через AJAX

  1. В самом простом случае команда вызова плагина выглядит так: {plugin:мойплагин} или {plugin:мойкласс_МойПлагин}
  2. При обращении через URL-адрес всё аналогично: /?plugin=мойплагин или /?plugin=мойкласс_МойПлагин (в URL также могут быть указаны другие GET-параматры, как слева, так и справа от того, что указано в примере)
  3. При обращении через AJAX нужно соблюсти следующие условия:
    • В HTML-коде веб-страницы должна присутствовать команда вызова специального плагина AJAX - {plugin:ajax} (если указать её несколько раз, дублирование вызова нужных модулей не произойдёт)
    • Вызов плагина через AJAX должен происходить через вызов ассинхронной JS-функции sendRequest(URL,objectID,getRequest,oldHTML,okProc), где
      • URL - URL-адрес плагина (пример смотрите выше)
      • objectID - ID HTML-тега, в который будет возвращён результат выполнения плагина
      • getRequest - оставляйте этот параметр без изменений
      • oldHTML - этот параметр не обязательный - можно оставить его пустым, но если заполнить его текстом или HTML-кодом, то он будет отображаться в результирующем теге objectID до того, как плагин вернёт результат
      • okProc - этот параметр не обязательный - можно оставить его пустым, но если указать в нём какую-либо JS-функцию, то она будет выполнена после того, как плагин вернёт результат (эта функция не должна принимать параметры)

Результаты выполнения плагинов

Плагины могут возвращать результирующий текст или HTML-код.

  • В самостоятельных плагинах результат присваивается PHP-переменной $echo
  • В плагинах из классов результат возвращается через оператор return(...);

От способа вызова плагина зависит то, где и как будет выводиться его результат:

  1. Если используется команда вызова плагина, то результат отобразится именно там, где была команда (результат заменит собой команду)
  2. Если используется обращение по URL-адресу, то результат выведется в браузере (при этом на веб-странице не будет ничего кроме результата выполнения плагина)
  3. Если используется вызов через AJAX, то результат будет выведен в тег, свойство id которого совпадает с тем, что указано в objectID

Параметры плагинов

Плагинам можно передавать параметры. В результате многие плагины могут выполняться в сотнях и в тысячах различных режимов

  1. Если используется команда вызова плагина, то она может выглядеть, например, так: {plugin:имя_плагина;color:red;type:apple;action:kick}, при этом
    • после имени плагина должна быть точка с запятой;
    • пары имя-значение (имя и значение параметра) отделяются друг от друга точкой с запятой;
    • имя параметра от значения того же параметра отделяется двоеточием:
    • в именах и в значениях параметров не допускается использовать двоеточия: и точки с запятой;
  2. Если используется обращение по URL-адресу, то для того же плагина с теми же параметрами URL будет такой: /?plugin=имя_плагина&params=color:red;type:apple;action:kick}, при этом
    • после имени плагина нужно написать &params=
    • пары имя-значение (имя и значение параметра) также отделяются друг от друга точкой с запятой;
    • имя параметра от значения того же параметра также отделяется двоеточием:
    • в именах и в значениях параметров не допускается использовать двоеточия: и точки с запятой;, а также амперсанд& и равно=
  3. Если используется вызов через AJAX, то к URL применяются те же требования, что и в предыдущем примере

В плагине эти параметры можно использовать, как элементы ассоциативного массива $params. Например, параметры из примеров выше будут доступны, как переменные $params['color']$params['type'] и $params['action'].

Плагины могут воспринимать только те параметры, которые в них запрограммированы. Список доступных параметров смотрите в документации к каждому конкретном плагину


CMS Zion WebEngine является бесплатной системой. Развивается за счёт рекламы, помощи веб-студии #webZion и других спонсоров.

 

Будем рады, если Вы поддержите нас любой суммой, а также поделитесь идеями на счёт каких-либо улучшений и доработок для CMS...

 

Заранее, большое, спасибо

 

Блог обновлений

Zion WebEngine 24.05.29
  • Доработан класс для управления пользователями (спасибо Киокушин Online):
    • Расширен список полей, доступных для указания контактных данных пользователя
    • Реализована возможность быстро заблокировать или разблокировать пользователя

Zion WebEngine Доступы/Пользователи Классы Как импортировать данные о пользователях из XML

Zion WebEngine 24.05.28
  • Доработан класс для управления интеграцией с Jivo:
    • Устранены недочёты при описании возможностей онлайн-консультанта в административном интерфейсе

Zion JivoSite Административный интерфейс Классы Онлайн-консультант Что такое Классы?

Zion WebEngine 24.05.24
  • Доработаны административные скрипты и элемент Связи (спасибо ТК Кило):
    • Удалён устаревший, более не использующийся функционал

Zion WebEngine Связи Элементы Что такое Элементы?

Zion WebEngine 24.04.25
  • Доработаны классы для управления базой данных, пользователями и проектом, а также страницы ошибок:
    • Улучшена интеграция с Рекламной сетью Яндекса
  • Доработан настраиваемый модуль для работы с Атол Онлайн:
    • Доработана интеграция с веб-сервисом онлайн-кассы
  • Доработан элемент Файл (спасибо Киокушин Online):
    • Реализован функионал, который можно использовать в том числе в нестандартных компонентах для загружки файлов

Zion WebEngine Zion Pub Hub Zion Export База данных/Таблицы данных Доступы/Пользователи Классы Настраиваемые модули Онлайн-касса Реакции на заказ Страницы ошибок Файлы/Папки Элементы Что такое Классы?

Zion WebEngine 24.04.24
  • Доработан элемент Связи (спасибо ТК Кило):
    • Удалён устаревший, более не использующийся функционал

Zion WebEngine Связи Элементы Что такое Элементы?

Zion WebEngine 24.04.23
  • Доработан класс для управления пользователями (спасибо Киокушин Online):
    • Упрощено отображение некоторых свойств пользователей

Zion WebEngine Что такое Свойства? Доступы/Пользователи Классы Свойства

Zion WebEngine 24.04.22
  • Доработан плагин универсального меню (спасибо ЛеоСталь):
    • Устранены недочёты из предыдущего обновления CMS

Zion WebEngine Что такое CMS Zion WebEngine? Меню/Списки/Навигация Обновления CMS Плагины

Zion WebEngine 24.04.17
  • Доработан плагин универсального меню (спасибо Киокушин Online):
    • Теперь более корректно обрабатываются свойства пустых списков

Zion WebEngine Меню/Списки/Навигация Плагины Свойства Плагин Menu

Zion WebEngine 24.04.15
  • Доработаны класс для управления пользователями и элемент Изображение (спасибо Киокушин Online):
    • Устранена опечатки
    • Реализован функионал, который можно использовать в том числе в нестандартных компонентах для загружки изображений

Zion WebEngine Доступы/Пользователи Изображение Классы Элементы Что такое Элементы?

Zion WebEngine 24.04.12
  • Доработан класс для управления экспортом данных в YML (спасибо DeviProf):
    • Реализована обработка множества спецсимволов, недопустимых в Товарах сообществ VK.com и в веб-сервисах Яндекса

Zion Export XML/RSS/1С/YML Импорт/Экспорт Классы Кодировки/Наборы символов Что такое Классы?

Zion WebEngine 24.04.05
  • Доработаны административные JS-скрипты (спасибо ТК Кило):
    • Удалён устаревший, более не использующийся функционал

Zion WebEngine

Zion WebEngine 24.04.03
  • Доработан класс для управления базой данных (спасибо Киокушин Online):
    • Устранена проблема с невозможностью выбора того, между какими разделами нужно вставить новый раздел в форме Добавление новой записи

Zion WebEngine База данных/Таблицы данных Классы Контент/Контентные единицы Формы Как редактировать Контент?

Zion WebEngine 24.04.01
  • Доработан плагин универсального меню (спасибо Moto-Retail18):
    • Теперь в пагинации (в списке подстраниц) ссылки автоматически используют (частичный или полный ЧПУ), что позитивно влияет на SEO-оптимизацию

Zion WebEngine SEO-параметры Адрес (URL)/ЧПУ/Переадресация Меню/Списки/Навигация Пагинация/Подстраницы Плагины Как оптимизировать сайт под поисковые системы?

Zion WebEngine 24.03.28
  • Доработан монитор очистки после обновления CMS (спасибо Киокушин Online):
    • Более корретно реализована автоматическая корректировка шаблонов для учёта обновлений в элементах

Zion WebEngine Что такое система Мониторинга? Мониторинг Обновления CMS Шаблоны контента Элементы

Zion WebEngine 24.03.26
  • Доработан элемент Связи (спасибо MasterProfi):
    • Расширены возможности некоторых плагинов

Zion WebEngine Связи Элементы Что такое Элементы?

Zion WebEngine 24.03.22
  • Доработаны элемент Связи и  административные JS-скрипты (спасибо MasterProfi):
    • Доработана настройка связей между пользователями и контентом:
      • Теперь для связей пользователей с контентом доступен весь функционал, доступный для связей контента с контентом

Zion WebEngine Доступы/Пользователи Контент/Контентные единицы Связи Элементы Как редактировать Контент?

Zion WebEngine 24.03.20
  • Доработан элемент Однострочное поле (спасибо GL Technology):
    • Создан новый плагин stringfield_Replace, позволяющий в указанной строке заменять одну подстроку на другую

Zion Catalog Однострочное поле Плагины Поиск текста Элементы Что такое Плагины?

Zion WebEngine 24.03.19
  • Доработан элемент Связи (спасибо MasterProfi):
    • Устранены недочёты при автоматической корректировке таблиц данных

Zion WebEngine База данных/Таблицы данных Связи Элементы Что такое Элементы?

Zion WebEngine 24.03.18
  • Доработаны элемент Связи, класс для управления пользователями и  административные JS-скрипты (спасибо MasterProfi):
    • Доработана настройка связей между пользователями и контентом:
      • Внешне настройка существующих связей и связей с контентом определённого типа уже выглядит также, как настройка связей контента с контентом:
        • Некоторые возможности будут внедрены в ближайших обновлениях

Zion WebEngine Доступы/Пользователи Классы Контент/Контентные единицы Обновления CMS Связи Элементы Что такое Тип контента?

Zion WebEngine 24.03.14
  • Доработаны элемент Связи и административные JS-скрипты (спасибо MasterProfi):
    • Реализована тонкая настройка связей между пользователями и контентом:
      • Настройка делается для каждой группы пользователей отдельно
      • Теперь здесь доступны все те же настройки, что и в случае связей контента с контентом:
        • Некоторые возможности будут внедрены в ближайших обновлениях

Zion WebEngine Доступ Групп пользователей Доступы/Пользователи Контент/Контентные единицы Обновления CMS Связи Элементы Что такое Контент?