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

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 20.07.02
  • Некоторые компоненты доработаны для внедрения в ближайших обновлениях новых способов онлайн-оплаты (спасибо Devi)

Zion WebEngine Zion Catalog Zion xPayment Обновления CMS Способы оплаты

Zion WebEngine 20.07.01
  • Повышено удобство при работе с автоматическими скидками (спасибо Devi):
    • Для плагина автоматического меню доступно новое условие IS_DISCOUNT_EXISTS??истина::ложь, позволяющее использовать разное оформление для товаров, на которые распространяется или не распространяется скидка
    • Доработаны классы для работы со скидами и корзиной:
      • Реализован функционал, упрощающий отображение цен, как с учётом скидок, так и без их учёта, а также с учётом и без учёта количества товара в корзине заказов
    • Доработан элемент Число:
      • Расширен набор подсказок по использованию цен со скидками и без скидок
  • Для пакетов Zion Qiwi и Zion Robokassa выпущены финальные обновления:
    • Теперь они будут развиваться в рамках нового пакета Zion xPayment, в котором скоро появится ещё больше способов оплаты и соответствующих настраиваемых модулей для интеграции с различными платёжными системами
  • Доработана система мониторинга:
    • Оптимизировано удаление устаревших компонентов
    • Оптимизирована проверка на соответствие веб-сервера некоторым техническим требованиям

Zion WebEngine Zion Catalog Zion xPayment Zion Robokassa Zion Qiwi Технические требования Robokassa Веб-сервер/Хостинг Классы Корзина для заказов Меню/Списки/Навигация Мониторинг Настраиваемые модули Обновления CMS Плагины Помощники/Мастеры/Инструкции/Подсказки Сайт-каталог Скидки/Наценки Способы оплаты Условия Число Элементы

Zion WebEngine 20.06.30
  • Доработан настраиваемый модуль для оплаты через банк (спасибо Новый стандарт):
    • Устранены некоторые недочёты при отображении кнопки для распечатки счёта
  • Значительно переработан алгоритм работы автоматических скидок (спасибо Devi):
    • Создан новый настраиваемый модуль для автомтического начисления скидки для всех подразделов указанного надраздела, например, для всех товаров из той или иной категории
    • Доработаны все другие настраиваемые модули скидок, а также классы для управления скидками и корзиной заказов:
      • Теперь модули скидок могут принимать больше параметров, чем раньше
    • Доработан элемент Число:
      • Актуализирована подсказка по использованию скидок

Zion UserControl Zion Catalog Категории Классы Корзина для заказов Место в структуре Настраиваемые модули Помощники/Мастеры/Инструкции/Подсказки Сайт-каталог Скидки/Наценки Способы оплаты Число Элементы

Zion WebEngine 20.06.26
  • Доработана система мониторинга для ядра:
    • Уменьшено количество статистических данных
    • Создан монитор очистки, который будет запускать только один раз после обвновления ядра:
      • Его задача удалить более ненужные, в том числе, устаревшие компоненты, а также скорректировать базу данных под новый формат в случае необходимости
  • Доработан класс для работы с обновлениями CMS:
    • Устранены некоторые недочёты
  • Доработан драйвер оболочки:
    • Переработан запуск системы мониторинга
  • Доработаны некоторые компоненты из пакета Zion Server:
    • Повышена совместимость с недостаточно качественно настроенными веб-серверами
    • Переработана система мониторинга

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

Zion WebEngine 20.06.25
  • Доработан класс для работы с email-сообщениями (спасибо Чистая Магия):
    • Переработан алгоритм отправки email-сообщений:
      • Ранее почтовый SMTP-сервер мог отклонить попытку отправки двух и более сообщения за один раз из соображений воспрепятствования распространению спама:
        • Такая ситуация могла возникнуть, в том числе, в тех случаях, когда включено email-уведомление клиента в интернет-магазине о том, что его заказ получен, или его статус изменён и т.п.
      • Теперь в случаях, когда нужно сделать отправку двух и более писем, первое сообщение отправляется, как обычно, а второе и последующие сохраняются в базе данных для отложенной отправки:
        • Отложенная отправка второго сообщения может быть сделана уже через доли секунд.
        • Для этих же целей были доработаны главные файлы гостевого и административного интерфейсов, а также главные файлы аутентификации и восстановления доступа:
          • В них отложенная отправка производится "в фоновом режиме", в том числе при AJAX-обращениях к плагинам, при переадресациях и во многих других случаях
  • Доработан класс для управления контентом (спасибо Hotel of Things):
    • Устранены некоторые недочёты при создании записей по умолчанию:
      • Поля в таблицах данных для элемента Основной текст теперь имеют более подходящий тип данных
  • Доработан класс для управления SMS-шлюзом (спасибо КБ Группа):
    • Доработана инструкция по работе с SMS-шлюзом:
      • В том числе добавлена информация я том, что необходимо сделать, если оператор "Мегофон" не доставляет Ваши SMS-сообщения из-за подозрения в рассылке спама
  • Доработаны некоторые компоненты из пакета Zion Booking:
    • Повышена совместимость с недостаточно качественно настроенными веб-серверами
  • Работа с корзиной для мусора теперь реализована полностью на новой платформе:
    • Удалены все компоненты, необходимые для работы корзины в старой платформе
  • Доработано меню администратора:
    • Удалены некоторые, более неактуальные подразделы из раздела Информация
    • Остальные его подразделы перенесены в раздел Инструменты
      • Оптимизирован алгоритм подсчёта места, занимаемого файлами
      • Оптимизирован алгоритм вывода информации о параметрах сервера

Zion WebEngine Zion Booking Что такое Административный интерфейс и Гостевой интерфейс? AJAX Email-сообщения SMS SMTP/PHP-mail Административный интерфейс Адрес (URL)/ЧПУ/Переадресация База данных/Таблицы данных Веб-сервер/Хостинг Гостевой интерфейс Доступы/Пользователи Интернет-магазин Классы Контент/Контентные единицы Корзина для мусора Меню администратора Основной текст Плагины Платформа Помощники/Мастеры/Инструкции/Подсказки Рассылки Реакции на заказ Спам Элементы

Zion WebEngine 20.06.22
  • Доработаны некоторые компоненты из пакета Zion Multi-Lang:
    • Повышена совместимость с недостаточно качественно настроенными веб-серверами

Zion Multi-Lang Веб-сервер/Хостинг Многоязычность/Языки

Zion WebEngine 20.06.19
  • Доработан класс для управления обновлениями:
    • Завершено внедрние возможности автоматической установки обновлений для CMS:
      • В будущих версиях мы продолжим улучшать данный функционал

Zion WebEngine Что такое CMS Zion WebEngine? Классы Обновления CMS

Zion WebEngine 20.06.11
  • Доработан класс для управления SMS-шлюзом (спасибо Moto-Retail18):
    • Повышена совместимость с не самыми свежими версиями CMS, в которых структура таблиц данных со способами уведомления о заказах изначально отличается от необходимой

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

Zion WebEngine 20.06.10
  • Доработан плагин универсального меню (спасибо ЦентрСпецЗапчасть):
    • Устранены проблемы с фильтрацией записей по подстроке
  • Доработан класс для управления базой данных  (спасибо Пермский период):
    • При создании автоматических ID учтена привычка некоторых пользователей оставлять пробелы в начале и/или в конце названий:
      • Ранее вместо этих пробелов из названия в ID (иногда) могли подставляться дефисы
  • Доработан класс для управления корзиной заказов (спасибо Moto-Retail18):
    • Учтена привычка некоторых пользователей заполнять форму заказа не сверху вниз, а снизу вверх:
      • Ранее из-за этого в случае смены способа доставки/самовывоза им пришлось бы заполнять некоторые поля дважды
  • Доработаны некоторые компоненты из пакета Zion Banners Manager:
    • Повышена совместимость с недостаточно качественно настроенными веб-серверами

Zion WebEngine Zion Catalog Zion Banners Manager База данных/Таблицы данных Баннеры Веб-сервер/Хостинг Классы Корзина для заказов Меню/Списки/Навигация Плагины Способы доставки/самовывоза Фильтрация Формы Плагин Menu

Zion WebEngine 20.06.05
  • Доработан класс для управления обновлениями:
    • Продолжаем внедрять возможность автоматической установки обновлений для CMS

Zion WebEngine Что такое CMS Zion WebEngine? Классы Обновления CMS

Ответы на вопросы

Как импортировать данные о пользователях из XML

Как загрузить данные о пользователях, например, о клиентах на сайт из 1С и аналогичных внешних систем через формат XML

Zion UserControl Zion Import XML/RSS/1С/YML Импорт/Экспорт Меню администратора

Что такое Меню администратора?

Общая информация о Меню администратора: что это, где его найти и как им пользоваться?

Zion WebEngine Zion UserControl Zion Catalog Zion Mail Back Zion SEO Booster Zion xDelivery Zion Import Zion Gallery Zion xPayment Zion Pub Hub Zion Export Zion JivoSite Zion Chat Zion Multi-Lang Zion Banners Manager Zion Sender Zion Server Email-сообщения SMS SMTP/PHP-mail XML/RSS/1С/YML Валюты Веб-сервер/Хостинг Галереи/Слайды Доступ Групп пользователей Доступы/Пользователи Изображение Импорт/Экспорт Интернет-магазин Категории Корзина для заказов Корзина для мусора Кэш/Кеш Меню/Списки/Навигация Меню администратора Многоязычность/Языки Обновления CMS Обмен сообщениями/Чат Обратная связь/Обратный звонок Онлайн-консультант Политика конфиденциальности Помощники/Мастеры/Инструкции/Подсказки Рассылки Реакции на заказ Сайт-каталог Скидки/Наценки Спам Способы доставки/самовывоза Способы оплаты Файлы/Папки ФЗ-152 Формы Шаблоны контента Эскизы

Что такое Тип контента?

Общая информация о Типах контента: что это, для чего они нужны, и как их использовать

Zion WebEngine Zion Catalog Zion Pub Hub Меню/Списки/Навигация Типы

Как редактировать Контент?

Как управлять страницами, редактируемыми полями, новостями, статьями, товарами, аксессуарами и другими контентными единицами?

Zion UserControl Zion Catalog Zion Pub Hub Адрес (URL)/ЧПУ/Переадресация Кэш/Кеш Меню/Списки/Навигация Помощники/Мастеры/Инструкции/Подсказки Фильтрация Шаблоны контента

Как настроить сайт?

Zion WebEngine 26 - CMS без абонентской платы