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

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 является бесплатной системой. Развивается за счёт рекламы, помощи ООО "Зион" и других спонсоров.

 

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

 

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

 

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

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

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

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

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

Zion WebEngine 24.03.04
  • Доработан класс для управления импортом данных о товарах из 1С/XML (спасибо Moto-Retail18):
    • За счёт оптимизации уменьшено количество обращений к базе данных

Zion Import XML/RSS/1С/YML Импорт/Экспорт Классы Сайт-каталог Как импортировать данные о товарах из XML

Zion WebEngine 24.02.12
  • Доработаны класс для управления шаблонами и монитор очистки после обновления CMS (спасибо Энерго-Профи):
    • Теперь при обновлении CMS и при открытии на редактирование любого из шаблонов в таблице данных шаблонов автоматически будут созданы все недостающие столбцы, необходимые для работы элементов

Zion WebEngine База данных/Таблицы данных Классы Мониторинг Обновления CMS Связи Шаблоны контента Элементы Что такое Шаблон контента?

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

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

Zion WebEngine 24.02.01
  • Доработан класс для управления контентом:
    • Устранены недочёты в некоторых формах для пользователей по умолчанию

Zion WebEngine Классы Контент/Контентные единицы Формы для пользователей Как редактировать Контент?

Zion WebEngine 24.01.29
  • Доработан элемент Связи (спасибо MasterProfi):
    • Добавлено несколько методов, упрощающих работу со связями между пользователями и контентом

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

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

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

Zion WebEngine 24.01.23
  • Доработан класс для управления пользователями (спасибо MasterProfi):
    • Теперь доступен просмотр даты регистрации пользователя (при наличии в комплекте поставки пакета Zion User Control)
  • Доработаны драйвер облочки и элементы Адрес и Место в структуре (спасибо Портал поддержки):
    • Расширился список символов, которые могут быть написаны в команде вызова плагина
    • Устранены проблемы с очисткой кэша при определении ЧПУ-адреса веб-страниц

Zion WebEngine Адрес (URL)/ЧПУ/Переадресация Дата/Время/TimeMashine Доступы/Пользователи Драйверы Классы Кодировки/Наборы символов Кэш/Кеш Место в структуре Плагины Элементы Что такое Плагины?

Zion WebEngine 24.01.19
  • Доработан плагин универсального меню (спасибо ТК Кило):
    • Теперь если для параметра select (что выбрать) указаны значения linked (связанные записи) или backlinks (обратные связи), то для параметра sort (сортировка) становятся доступны только следующие варианты:
      • id - ID связи
      • fromid - ID связывающейся записи
      • toid - ID связываемой записи
      • reason - причина связи
      • info - информация о связи
      • price - цена связи
      • description - описание связи

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

Zion WebEngine 24.01.17
  • Доработан элемент Связи (спасибо MasterProfi):
    • Теперь при подсчёте количества связей пользователя с контентом, можно указать типы:
      • Можно указать несколько типов через запятую, чтобы подсчитать количество связей с контетом только этих типов
      • Без указания хотя бы одного типа будет подсчитано колчичество всех связей указанного пользователя с контентом (как и раньше)

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

Zion WebEngine 24.01.16
  • Доработан класс для управления базой данных (спасибо МедИнвест):
    • Теперь при использовании кнопки Переместить в указанное место для контента будут отображаться только записи с тем же местом в структуре, что и у перемещаемой записи:
      • Так перемещение будет работать быстрее, а отсутсвтие "лишних" записей в списке избавит от путаницы
      • В других списках в административном интерфейсе перемещение работает, как прежде

Zion WebEngine Административный интерфейс База данных/Таблицы данных Классы Контент/Контентные единицы Место в структуре Элемент "Место в структуре"

Zion WebEngine 24.01.12
  • Доработаны система мониторинга SEO-оптимизации и элемент Место в структуре (спасибо ZS Москва):
    • Устранены проблемы при формировании огромных файлов sitemap.xml

Zion WebEngine Zion SEO Booster SEO-параметры XML/RSS/1С/YML Место в структуре Мониторинг Элементы Как оптимизировать сайт под поисковые системы?

Zion WebEngine 24.01.12
  • Доработано меню администратора для пакета Zion Export:
    • Скорректировано описание возможностей пакета
    • Скорректированы названия пунктов меню

Zion Export Что такое Меню администратора? Импорт/Экспорт Меню администратора

Zion WebEngine 24.01.03
  • Доработан класс для управления проектом:
    • Внедрены новые стандарты CMS

Zion WebEngine Что такое CMS Zion WebEngine? Классы

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

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

Zion WebEngine 23.12.22
  • Доработан класс для управления типами (спасибо МедИнвест):
    • Теперь при просмотре списка контента в административном интерфейсе системные столбцы отображаются раньше дополнительных

Zion WebEngine Административный интерфейс Классы Контент/Контентные единицы Типы Как управлять сайтом?

Zion WebEngine 23.12.21
  • Доработана система мониторинга для Ядра:
    • Ещё некоторые уведомления теперь не отображаются при работе на локальном веб-сервере
  • Доработаны классы для управления типами и базой данных:
    • Реализована возможность скрывать/отображать любые системные столбцы при просмотре списка контента в административном интерфейсе
  • Доработаны элементы Число и Дата:
    • Более корректно отображаются кнопки для массового изменения значений в соответсвующих столбцах

Zion WebEngine Zion Pub Hub Что такое система Мониторинга? Административный интерфейс База данных/Таблицы данных Веб-сервер/Хостинг Дата/Время/TimeMashine Классы Контент/Контентные единицы Мониторинг Типы Уведомления Число Элементы

Zion WebEngine 23.12.20
  • Доработаны классы для управления обновлениями CMS на строне клиента и на стороне сервера (спасибо Пермский период):
    • Устранены некоторые недочёты при отправке и при сохранении статистических данных об установленном комплекте поставки

Zion WebEngine Zion Server Веб-сервер/Хостинг Классы Обновления CMS Что такое Классы?

Zion WebEngine 23.12.18
  • Доработана система мониторинга SEO-оптимизации (спасибо Куединский Мясокомбинат):
    • Теперь в файл sitemap.xml не попадают контентные единицы, у которых в шаблоне нет элемента HTML-код веб-страницы

Zion SEO Booster HTML-код веб-страницы SEO-параметры XML/RSS/1С/YML Контент/Контентные единицы Мониторинг Шаблоны контента Элементы Элемент "HTML-код веб-страницы"