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

19.02.2019

Все плагины в 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 должен быть либо реакцией на действие (вроде onclick="sendRequest...") либо частью свойства ссылки href="javascript:sendRequest..."
    • В реакции на действие или в ссылке должна вызываться следующая функция со следующими параметрами: 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 22.12.01
  • Доработан плагин универсального меню (спасибо Moto-Retail18):
    • Устранена проблема с использованием параметра select со значением all в случаях, когда нужно отобразить список транспортных компаний, например, в форме оформления заказа в интернет-магазине
  • Доработан класс для управления пользователями (спасибо ТК Кило):
    • Приняты меры на случай невозможности отправки письма с данными авторизации только что созданного системного администратора
  • Доработан класс для управления SMS-уведомлениями:
    • Налажено более корректное создание столбцов в случае их отсутствия в таблице данных реакций на заказы

Zion WebEngine Email-сообщения SMS База данных/Таблицы данных Доступы/Пользователи Интернет-магазин Корзина для заказов Меню/Списки/Навигация Плагины Реакции на заказ Способы доставки/самовывоза Формы Плагин Menu

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

Zion Server База данных/Таблицы данных Веб-сервер/Хостинг Классы Обновления CMS Что такое Классы?

Zion WebEngine 22.11.24
  • Доработаны класс для управления обновлениями на стороне сервера и система мониторинга для сервера обновлений:
    • Реализована новая страница приветствия для пользователей CMS

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

Zion WebEngine 22.11.19
  • Доработан класс для управления обновлениями на стороне сервера и система мониторинга для сервера обновлений:
    • Устранены некоторые недочёты

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

Zion WebEngine 22.11.18
  • Доработан класс для управления импортом из 1С/XML (спасибо Moto-Retail18):
    • Теперь товары, ссылающиеся на несуществующие (возможно, ранее удалённые) категории, будут автоматически удаляться при импорте:
      • Это касается, как импортируемых в данный момент, так и уже существующих в основной базе данных записей

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

Zion WebEngine 22.11.10
  • Доработан класс для управления местом в структуре (спасибо Moto-Retail18):
    • Устранена вероятность появления ошибки в случаях, когда та или иная запись является подразделом несуществующей в базе данных записи

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

Zion WebEngine 22.11.09
  • Доработан плагин универсального меню (спасибо Moto-Retail18):
    • Для параметра select создан новый вариант all - позволяет отобразить все записи с учётом других параметров фильтрации:
      • Указание параметра factor при этом не требуется, так как он ни на что не влияет
    • Использовать варианта children-all в параметре select для крупных сайтов настоятельно не рекомендуется, т.к. он создаёт очень большую нагрузку на базу данных, например, при поиске по всем подразделам той или иной записи (например, каталога товаров):
      • Если необходимо отобразить все записи (или выполнить поиск по всем записям), которые являются подразделами того или иного надраздела (например, каталога товаров), то лучше использовать не select:children-all, а select:all и указать через запятую в параметре types типы, к которым относятся такие подразделы

Zion WebEngine База данных/Таблицы данных Меню/Списки/Навигация Место в структуре Плагины Поиск текста Сайт-каталог Типы Плагин Menu

Zion WebEngine 22.11.08
  • Доработан класс для управления обновлениями на стороне сервера и система мониторинга для сервера обновлений:
    • Устранены некоторые недочёты

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

Zion WebEngine 22.11.04
  • Доработан класс для управления базой данных (спасибо Moto-Retail18):
    • Устранены ошибки при использовании Memcache
    • Кэширование теперь происходит с использованием сжатия, что позволяет сильно увеличить объём кэша, повысить общую производительность и снизить нагрузку на процессор и базу данных

Zion WebEngine База данных/Таблицы данных Классы Кэш/Кеш Что такое Классы?

Zion WebEngine 22.10.21
  • Доработан плагин TimeMashine (спасибо Средняя общеобразовательная школа № 118):
    • Устранены ошибки при отображении дат в виде "Послезавтра", "В следующем году", "На прошлой неделе" и т.п.
  • Доработан класс для управления обновлениями на стороне сервера:
    • Более корректно реализовано определение доменов и поддоменов сайтов клиентов

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

Zion WebEngine 22.10.20
  • Доработаны классы для управления пользователями, базой данных, проектом и обновлениями на стороне сервера, а также страницы ошибок:
    • Изменены адреса, по которым можно получить различную справочную информацию от Портала поддержки

Zion WebEngine Zion Server Адрес (URL)/ЧПУ/Переадресация База данных/Таблицы данных Веб-сервер/Хостинг Доступы/Пользователи Классы Обновления CMS Страницы ошибок Что такое Классы?

Zion WebEngine 22.10.19
  • Доработан элемент Дата:
    • Устранена проблема при быстром просмотре дат в списке записей в административном интерфейсе:
      • Если для той или иной записи дата ещё не была указана, это могло привести к фатальной ошибке
  • Доработан монитор работоспособности сервера обновлений:
    • Внесены корректировки в связи с продолжающейся реорганизацией страницы приветствия в административном интерфейсе
  • Доработан класс для управления обновлениями на стороне сервера:
    • Внесены корректировки в связи с начавшейся реорганизацией автоматических обновлений CMS:
      • Теперь обновление доступно при заходе с любого домена, закреплённого за сайтом подписчика на обновления:
        • Переход на новую систему ещё не завершён - для некоторых сайтов обновление пока доступно только с одного домена

Zion Pub Hub Zion Server Что такое Административный интерфейс и Гостевой интерфейс? Административный интерфейс Веб-сервер/Хостинг Дата/Время/TimeMashine Классы Мониторинг Обновления CMS Типы Элементы

Zion WebEngine 22.10.18
  • Доработан элемент Выбор одного из вариантов:
    • Поле Свой вариант теперь появляется только, когда это необходимо
  • Доработаны административные JS-скрипты:
    • Расширен список доступных JS-функций
  • Доработан элемент Связи:
    • Теперь для каждого шаблона можно настроить список типов, с записями которых может быть установлена связь в ту или в другую сторону
    • По умолчанию для связи доступны все типы
    • Также доступен просмотр древовидного списка всех записей всех типов и список уже установленных связей
    • Если ни один тип не выбран, то функционал, необходимый для связывания скрывается
  • Доработан класс для управления базой данных:
    • Теперь для использования ID в том числе доступен символ . (точка)
  • Доработан монитор работоспособности сервера обновлений:
    • Внесены корректировки в связи с начавшейся реорганизации страницы приветствия в административном интерфейсе

Zion WebEngine Zion Catalog Zion Server Административный интерфейс База данных/Таблицы данных Веб-сервер/Хостинг Выбор одного из вариантов Классы Кодировки/Наборы символов Мониторинг Обновления CMS Связи Типы Шаблоны контента Элементы Что такое Элементы?

Zion WebEngine 22.10.14
  • Доработан XML/1C-экспорт данных о заказе в интернет-магазине (спасибо Moto-Retail18):
    • Учтена вероятность указания в комментарии к заказу и в других полях некоторых спецсимволов
  • Доработан класс для управления миграцией со старых версий CMS (спасибо Мария и Иоанн):
    • Улучшена миграция меню/списков и плагинов, необходимых для функционирования интернет-магазина
  • Доработан класс для управления навигацией:
    • Из списка меню по умолчанию удалены некоторые архаизмы
  • Доработан класс для управления корзиной заказов:
    • Более продуманно организованы поля в форме заказа

Zion WebEngine Zion Catalog Zion Export XML/RSS/1С/YML Импорт/Экспорт Интернет-магазин Классы Кодировки/Наборы символов Корзина для заказов Меню/Списки/Навигация Миграция Реакции на заказ Плагин Menu

Zion WebEngine 22.10.13
  • Доработан класс для управления миграцией со старых версий CMS (спасибо Мария и Иоанн):
    • Улучшена миграция товаров, их категорий и характеристик, а также обработчиков, необходимых для функционирования интернет-магазина
  • Доработан класс для управления контентом:
    • Теперь более корректно отображается список характеристик с указанных вкладок:
      • Как только заполненных, так и всех характеристик

Zion WebEngine Вкладки Интернет-магазин Категории Классы Контент/Контентные единицы Миграция Обработчики Характеристики/Разновидности Что такое Вкладки?

Zion WebEngine 22.10.05
  • Доработан класс для управления базой данных (спасибо Испытательный центр "Строитель"):
    • Теперь CMS отправляет корректный код ошибки, в случае, если недоступен или некорректно сконфигурирован Memcached:
      • Это может привести, в том числе, к автоматической остановке Ваших рекламных кампаний, когда с сайтом, что-то не так, и к автоматическому возобновлению рекламы, когда сайт начнёт работать корректно
    • Более корректно налажено использование функционала Memcached
  • Доработаны классы для управления проектом:
    • Упрощён вывод тех или иных ошибок через новую функцию, для которой доступно указание нескольких параметров:
      • Код ошибки
      • Заголовок страницы ошибки
      • Текст с описанием и рекомендацией по устранению ошибки

Zion WebEngine Что такое CMS Zion WebEngine? База данных/Таблицы данных Классы Кэш/Кеш Страницы ошибок

Zion WebEngine 22.10.04
  • Доработан общий монитор функциональности SEO-оптимизации (спасибо ZS-Moskva):
    • Более продуманно организовано формирование файла SiteMap.XML:
      • Для этого теперь требуется многократно меньше оперативной памяти
      • Сам файл теперь занимает в 2 раза меньше места на диске
      • Доступно формирование значительно более крупного файла без создания проблем для работы других компонентов CMS

Zion SEO Booster SEO-параметры XML/RSS/1С/YML Мониторинг Элемент "SEO-параметры"

Zion WebEngine 22.10.03
  • Доработан класс для управления проектом (спасибо Manner Sensortelemetrie):
    • Устранены некоторые недочёты, допущенные в предыдущем обновлении
  • Доработан класс для управления email-сообщениями:
    • Более продуманно организована автоматическая корректировка таблицы данных для хранения email-сообщений

Zion WebEngine Email-сообщения База данных/Таблицы данных Классы Обновления CMS Что такое Классы?

Zion WebEngine 22.09.30
  • Доработаны классы для управления баннерами и баннерными местами, контентом, способами доставки/самовывоза и оплаты, автоматическими скидками и скидочными уровнями, точками доставки/самовывоза, галереями, email-сообщениями и рассылками, меню и списками, заказами и реакциями на заказы, вкладками, шаблонами и типами, транспортными компаниями, пользователями и их группами:
    • Более продуманно организован живой поиск в административном интерфейсе для этих классов:
      • Теперь в начале списка выводятся записи, в названиях или в ID которых содержится поисковый запрос:
        • Уже далее отображаются все остальные записи - те, которые содержат искомую фразу в других полях
      • Устранены опечатки в результатах поиска
  • Доработан класс для управления обновлениями на стороне сервера:
    • Внесены корректировки в процедуру обновления CMS - ведутся испытания

Zion WebEngine Zion Catalog Zion xDelivery Zion Gallery Zion Banners Manager Zion Sender Zion Server Email-сообщения Административный интерфейс Баннеры Веб-сервер/Хостинг Вкладки Галереи/Слайды Доступ Групп пользователей Доступы/Пользователи Классы Контент/Контентные единицы Корзина для заказов Меню/Списки/Навигация Обновления CMS Поиск текста Рассылки Реакции на заказ Скидки/Наценки Способы доставки/самовывоза Способы оплаты Типы Шаблоны контента Что такое Тип контента?

Zion WebEngine 22.09.27
  • Доработан класс для управления миграцией со старых версий CMS (спасибо Manner Sensortelemetrie):
    • Улучшена миграция товаров, их категорий и плагинов, необходимых для каталога
    • Более продуманно организована корректировка HTML-кода, необходимого для отображения уведомлений

Zion WebEngine Что такое CMS Zion WebEngine? HTML-код веб-страницы Категории Классы Миграция Сайт-каталог Уведомления