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

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

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 20.05.25
  • Доработана форма обратной связи (спасибо Hotel Of Things)
    • Устранена проблема отображения формы с параметрами по умолчанию

Zion Mail Back Обратная связь/Обратный звонок Формы

Zion WebEngine 20.05.24
  • Оптимизирован дистибутив пакет Zion Pub Hub (спасибо Group Experience):
    • Устранена проблема при замене эскиза по умолчанию во время обновления CMS

Zion Pub Hub Что такое CMS Zion WebEngine? Эскизы

Zion WebEngine 20.05.22
  • Оптимизирован дистибутив пакет Zion Mail Back (спасибо Пермский период):
    • Из него удалены некоторые файлы, которые также присутствуют в ядре
  • Доработаны очень многие компоненты (спасибо Group Experience):
    • Повышена совместимость с недостаточно качественно настроенными веб-серверами

Zion WebEngine Zion Gallery Zion Mail Back Zion SEO Booster Zion JivoSite Что такое Комплект поставки? Email-сообщения Веб-сервер/Хостинг

Zion WebEngine 20.05.19
  • Оптимизирован дистибутив ядра (спасибо Hotel Of Things):
    • Из него удалены некоторые файлы, которые создаются самостоятельно при установке или обновлении CMS
  • Доработан класс для управления базой данных:
    • Устранена проблема с созданием новой записи контента без выбора шаблона (спасибо Строительные машины):
      • Если для типа контента выбран шаблон по умолчанию, то проблем не было
      • Теперь проблема не возникает и для типов контента без шаблона по умолчанию
    • Реализована возможность включения/отключения обратного порядка при отображение любых списков в административном интерфейсе (спасибо Федерация Киокусинкай Пермского края):
      • При этом становятся недоступны перетаскивание записей и кнопки перемещения записей (чтобы не вводить пользователей в заблуждение)
      • Для каждого списка обратный порядок включается/отключается отдельно:
        • Например, страницы Вы можете просматривать в обычном порядки, а новости - в обратном (от старых к новым) 
  • Доработан класс для управления галереями (спасибо Ломбард "ЗалогАвто"):
    • Устранена проблема, при которой в случае удаления элемента галереи из одного шаблона, могли удалиться слайды из контента, никак не связанного с этим шаблоном
  • Доработаны некоторые драйвера, мониторы, формы и обработчики:
    • Продолжаем снижать зависимость некоторых компонентов от корзины
  • Оптимизированы драйверы Converter, Imaginer, TreeStructer:
    • Удалены функции, которые по различным причинам более не используются, например, устарели и/или уже реализованы иначе в других компонентах
  • Доработан настраиваемый модуль для уведомлений о заказах на системный e-mail:
    • Устранены недочёты в некоторых подсказках
  • Доработан класс для управления SMS-шлюзом:
    • Теперь в названии организации-отправителя можно в том числе использовать кавычки
  • Доработан класс для управления контентом (спасибо Devi59):
    • Теперь при правке отфильтрованного списка контентных единиц на панели инструментов не отображается кнопка Удалить все записи, чтобы не вводить в заблуждение пользователя, который попытавшись удалить только отфильтрованные записи, в результате удалит все записи

Zion WebEngine Zion Catalog Zion Gallery Zion Sender Email-сообщения SMS База данных/Таблицы данных Галереи/Слайды Драйверы Изображение Классы Кодировки/Наборы символов Контент/Контентные единицы Место в структуре Мониторинг Настраиваемые модули Обработчики Панель инструментов Помощники/Мастеры/Инструкции/Подсказки Типы Уведомления о заказах Файлы/Папки Фильтрация Формы Шаблоны Элементы Как редактировать Контент?

Zion WebEngine 20.05.13
  • Доработан монитор функциональности PHP (спасибо С-Полимер):
    • Реализована дополнительная проверка на наличие некоторых библиотек, необходимых для корректной работы с эскизами

Zion WebEngine Что такое система Мониторинга? PHP Мониторинг Эскизы

Zion WebEngine 20.05.05
  • Доработан класс для управления JivoSite (спасибо Color House):
    • Теперь все ссылки из раздела CMS для настройки интеграции с онлайн-консультантом ведут на русскую, а не на английскую версию JivoSite
  • Доработан класс для управления пользователями (спасибо ЛеоСталь):
    • Кнопки в формах входа и сброса пароля для административного интерфейса теперь расположены так, чтобы не путать малоопытных пользователей
  • Доработан класс для управления шаблонами (спасибо Group Experience):
    • Создание записей по умолчанию скорректировано так, чтобы создание и наполнение новых сайтов происходило быстрее
  • Доработаны многие классы и обработчики:
    • Сохранение различных опций в них теперь происхоит без связи с некоторыми устревшими компонентами

Zion WebEngine Zion JivoSite Zion Import Административный интерфейс Доступы/Пользователи Классы Онлайн-консультант Формы Шаблоны Что такое Шаблон контента?

Zion WebEngine 20.04.29
  • Доработана форма обратной связи (спасибо Group Experience):
    • Реализована возможность скрывать выбор тем сообщений в форме обратной связи, но при этом делать отправку email-сообщений нужному контакту
  • Устранены некоторые недочёты при настройке точек доставки/самовывоза
  • Создан класс для работы с обновлениями:
    • Начато внедрение функционала для регулярной автоматической проверки на обновления CMS

Zion WebEngine Zion Mail Back Zion xDelivery Email-сообщения Классы Обратная связь/Обратный звонок Способы доставки/самовывоза Формы

Zion WebEngine 20.04.23
  • Доработаны класс для управления точками доставки/самовывоза и интеграцией с API Яндекс.Карт (спасибо Hotel Of Things):
    • Полностью переработан принцип формирования точек на карте:
      • Настройка точек теперь делается немного дольше, так как требуется указание не только адреса, но и координат:
        • Ссылка на инструмент для поиска нужных координат доступен при настройке интеграции API Яндекс.Карт и при настройке точек доставки/самовывоза
      • Формирование карты теперь происходит значительно быстрее и точки на ней всегда отображаются корректно
  • Доработана система мониторинга для ядра:
    • Теперь выдаются уведомления о необходимости указать координаты (если они ещё не указаны) для точек доставки/самовывоза и для центра карты

Zion WebEngine Zion Catalog Zion xDelivery Классы Мониторинг Способы доставки/самовывоза

Zion WebEngine 20.04.21
  • Доработан класс для интеграции с API Яндекс.Карт (спасибо Hotel Of Things):
    • Реализована обработка ошибки при которой на карте отображаются не все необходимые точки самовывоза:
      • В этом случае страница будет автоматически перезагружена
  • Доработан главный файл гостевого интерфейса:
    • Произведена небольшая оптимизация кода

Zion WebEngine Zion Catalog Что такое Административный интерфейс и Гостевой интерфейс? Гостевой интерфейс Классы Способы доставки/самовывоза

Zion WebEngine 20.04.20
  • Доработан настраиваемый модуль для управления самовывозом (спасибо Devi59):
    • Теперь если выбран другой способ доствки/самовывоза, то под названием данного способа выводится не юридический адрес организации, а предложение выбрать точку
    • Если же выбран данный способ доставки/самовывоза и уже выбрана точка, то теперь под названием данного способа отображается название выбранной точки, а не её адрес

Zion xDelivery Настраиваемые модули Способы доставки/самовывоза

Zion WebEngine 20.04.17
  • Доработан класс для управления корзиной заказов (спасибо Devi59):
    • Внесены корректировки в работу с заказами, товары в которых могли быть удалены до завершения оформления заказа
  • Доработан настраиваемый модуль для уведомлений о заказах по SMS (спасибо Hotel Of Things):
    • Теперь можно отключить SMS-уведомления о новом или изменёном заказе для администратора, но оставить включёнными аналогичные SMS-уведомления для покупателей.
  • Доработаны классы для управлени базой данных и заказами:
    • Теперь разрешены единичные и массовые удаления заказов
    • Изменён порядок кнопок, доступных для записей в административном интерфейсе
    • Устраннены недочёты при фильтрации заказов
  • Доработан главный файл гостевого интерфейса:
    • Устранены недочёты при загрузке настроек некоторых классов 

Zion WebEngine Zion Catalog Что такое Административный интерфейс и Гостевой интерфейс? SMS Административный интерфейс База данных/Таблицы данных Гостевой интерфейс Интернет-магазин Классы Корзина заказов Настраиваемые модули Уведомления о заказах Фильтрация

Zion WebEngine 20.04.14
  • Доработан плагин универсального меню (спасибо ЦентрСпецЗапчасть):
    • Расширены возможности фильтрации, дополняющие текстовый поиск:
      • В случае, когда нужно найти одну и ту же подстроку в любом (из необходимых) полей, используйте (как и прежде) параметры search (искомый текст) и search-cols (поля, в которых нужно искать)
      • В случае, когда в разных столбцах нужно найти разные подстроки, используйте параметр filter со значением on и GET-массивы filter[] и filterFunc[]:
        • В качестве значений для соответствующих элементов GET-массива filterFunc[] используйте новый доступный вариант substring (искомый текст)

Zion WebEngine POST/GET-данные Меню/Списки/Навигация Плагины Поиск текста Фильтрация Плагин Menu

Zion WebEngine 20.04.13
  • Доработан класс для управления пользователями (спасибо Hotel Of Things):
    • Упрощена смена регистрационных и некоторых контактных данных
  • Доработан класс для управления заказами:
    • Расширены возможности фильтрации заказов по дате доставки/самовывоза

Zion WebEngine Zion Catalog Доступы/Пользователи Классы Корзина заказов Фильтрация

Zion WebEngine 20.04.10
  • Доработан класс для управления импортом из CSV/Excel (спасибо ЦентрСпецЗапчасть):
    • Более продумано организовано создание связей при импорте данных

Zion Import CSV/Excel Импорт/Экспорт Классы Связи

Zion WebEngine 20.04.09
  • Доработан класс для управления пользователями (спасибо Hotel Of Things):
    • Упрощено указание имени (не логина) пользователя при регистрации

Zion WebEngine Доступы/Пользователи Классы

Zion WebEngine 20.04.08
  • Доработаны классы для управления заказами, базой данных, SMS-шлюзом и самовывозом (спасибо Hotel Of Things):
    • Стали доступны SMS-уведомления об изменении статуса доставки/самовывоза:
      • Доступно не для всех способов и статусов доставки/самовывоза

Zion WebEngine Zion Catalog Zion xDelivery SMS Классы Корзина заказов Способы доставки/самовывоза Уведомления о заказах

Zion WebEngine 20.04.06
  • Доработан класс для управления заказами (спасибо Hotel Of Things):
    • Устранены недочёты при фильтрации заказов по дате создания
    • Реализована фильтрация заказов по дате доставки/самовывоза:
      • Доступно только при наличии Zion xDelivery

Zion Catalog Классы Корзина заказов Способы доставки/самовывоза Фильтрация

Zion WebEngine 20.04.03
  • Доработан класс для управления базой данных (спасибо Hotel Of Things):
    • Устранены недочёты при обновлении таблицы данных в случае, если указаны не все необходимые параметры запроса

Zion WebEngine База данных/Таблицы данных Классы

Zion WebEngine 20.03.31
  • Доработан класс для управления контентом (спасибо Hotel Of Things):
    • Устранены недочёты при создании записей по умолчанию в случаях, когда в шаблоне должны быть изображения
  • Доработан настраиваемый модуль для уведомления о заказах на системный email:
    • Теперь в письме отображается информация только о заполненных полях
  • Доработан класс для управления базой данных:
    • Более продуманно организовано сохранение данных о статусе доставки/самовывоза

Zion WebEngine Zion Catalog Email-сообщения База данных/Таблицы данных Изображение Классы Контент/Контентные единицы Настраиваемые модули Способы доставки/самовывоза Уведомления о заказах Шаблоны