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

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 X9.05.25
  • Доработан элемент Расписание: (спасибо Школа 118):
    • Стало доступно листание календаря по неделям, в том числе листание на текущую неделю в административном интерфейсе
    • Реализовано автоматическое создание таблиц данных
    • Реализовано созданию временных промежутков доступных для бронирования:
      • В том числе уже сделана возможность автоматического предложения новых даты/времени для следующего после только что добавленного периода:
        • Продолжительность предлагается такая же, но её можно изменить
        • Если продолжительно не менять, можно очень быстро заполнить расписание одинаковыми по продолжительности периодами, следующими друг за другом
    • Реализовано отображение временных промежутков доступных для бронирования
    • Разработка ещё не завершена

Zion Booking Административный интерфейс База данных/Таблицы данных Бронирование/Расписание Дата/Время/TimeMashine Элементы

Zion WebEngine X9.05.24
  • Создан пакет Zion Booking (спасибо Школа 118):
    • Он позволяет осуществлять бронирование различных объектов и назначения встреч на определённый доступный временной промежуток
    • Создан класс для нового элемента контента Расписание:
      • Уже реализовано отображение текущей недели в административном интерфейсе
      • Разработка ещё не завершена

Zion Booking Административный интерфейс Бронирование/Расписание Классы Контент/Контентные единицы Элементы

Zion WebEngine X9.05.23
  • Доработана форма обратной связи (спасибо Школа 118):
    • Учетно, что она может быть использована нетолько для вопросов

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

Zion WebEngine X9.05.21
  • Доработан импорт данных из 1С/XML (спасибо Moto-Retail18):
    • Устранены некоторые недочёты при импорте данных об изображениях
  • Доработан класс, облегчающий миграцию со старых версий CMS на новые (спасибо Школа 118):
    • Более продумано организована конвертация данных для доступа администратора
    • Реализовано отображение отчёта о миграции
    • Переделана обработка эскизов и изображений
    • Для новостей и категорий новостей создаются особые идентификаторы во избежании их дублирования друг с другом и со страницами
    • Реализована конвертация обращений к свойствам и плагинам из старой платформы в новую

Zion WebEngine Zion Import XML/RSS/1С/YML Доступы/Пользователи Изображение Импорт/Экспорт Категории Контент/Контентные единицы Миграция Плагины Платформа Свойства Эскизы

Zion WebEngine X9.05.18
  • Доработана система мониторинга для заказов (спасибо Moto-Retail18):
    • Настройки оформления формы заказа теперь не будут заменяться настройками по умолчанию при обновлении CMS до более свежей версии
  • Доработан класс для управления заказами:
    • Определение номера нового заказа теперь определяется более правильно
    • Скорректирована сортировка заказов при просмотре их списка в административном интерфейсе
  • Доработано меню администратора (спасибо Savory Wine):
    • Скидки по умолчанию теперь создаются до входа в нужный раздел

Zion Catalog Административный интерфейс Классы Корзина для заказов Меню администратора Мониторинг Обновления CMS Скидки/Наценки Формы

Zion WebEngine X9.05.20
  • Создан класс, облегчающий миграцию со старых версий CMS на новые (спасибо Школа 118):
    • Пока налажен переход с версии Zion WebEngine X6.06.15 - в дальнейшем список версий будет расширяться
    • Налажена конвертация опций проекта и данных для доступа администратора
    • Налажен перенос JS-, CSS-, ICO-файлов и содержимого папки upload (с автоматическим созданием подпапок)
    • Налажено автоматическое создание меню страниц, категорий новостей и новостей, а также списка новостей
    • Налажена конвертация содержимого папок bases, content и ini в формат новой платформы
      • Пока это сделано только для навигации, страниц, новостей и их категорий
      • Пока шаблоны нужно создавать автоматически
      • Пока редактируемые поля обрабатываются, как страницы
      • Эскизы и изображения для категорий новостей пока не обрабатываются
      • Пока не учтена ситуация, когда для новости выбрано несколько категорий
    • Пока не налажена адаптация нестандартных и некоторых устаревших компонентов
    • Многие доработки будут сделаны в будущих версиях

Zion WebEngine Zion WebEngine X6.06.15 Что такое CMS Zion WebEngine? База данных/Таблицы данных Доступы/Пользователи Изображение Категории Классы Контент/Контентные единицы Меню/Списки/Навигация Миграция Платформа Файлы/Папки Шаблоны контента Эскизы

Zion WebEngine X9.05.14
  • Доработан класс для управления пользователями (спасибо Единый Центр Недвижимости):
    • Теперь, если нажать на кнопку Обратиться в техподдержку при входе в административный интерфейс и при попытке восстановить пароль, можно сразу же попасть на инструкцию по вопросу Что делать, если забыли логин и/или пароль?

Zion WebEngine Что делать, если забыли логин и/или пароль? Административный интерфейс Доступы/Пользователи Классы Помощники/Мастеры/Инструкции/Подсказки

Zion WebEngine X9.05.08
  • Доработан плагин универсального меню (спасибо Белый и пушистый):
    • Устранена вероятность возникновения ошибок при отображении списка последних просмотренных записей в случае, если ни одна запись ещё не была просмотрена

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

Zion WebEngine X9.05.07
  • Доработан импорт из 1С/XML (спасибо Белый и пушистый):
    • Реализована возможность не использовать отдельный файл при импорте данных о категориях товаров:
      • При этом данные берутся из файла с данными о товарах:
        • Становятся доступны дополнительные настройки
    • Имена файлов изображений теперь формируются автоматически из ID товара и расширения оригинального файла:
      • Это решает проблемы с кодировкой при использовании файлов с русскоязычными именами
    • Из данных, которые являются числами (в том числе ценами) теперь автоматически удаляются пробельные символы

Zion Import XML/RSS/1С/YML Изображение Импорт/Экспорт Классы Кодировки/Наборы символов Сайт-каталог Файлы/Папки Число

Zion WebEngine X9.05.02
  • Доработаны класс для управления навигацией и плагин универсального меню (спасибо МТС Пермь):
    • Стало доступно условие, благодаря выполнению или невыполнию которого, можно по-разному оформить элементы списка в зависимости от того, сколько в этом списке записей
    • Дополнен список подсказок по доступным условиям

Zion WebEngine Классы Меню/Списки/Навигация Плагины Помощники/Мастеры/Инструкции/Подсказки Условия

Zion WebEngine X9.05.06
  • Доработаны класс для управления базой данных (спасибо Безопасная Россия):
    • Устранена вероятность возникновения ошибок при массовом удалении записей в случае неполного комплекта поставки

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

Zion WebEngine X9.04.29
  • Доработан класс для управления файлами и папками (спасибо Спортивная школа киокусинкай Пермского края):
    • Устранена ошибка, возникавшая при попытке автоматической очистки кэша для отсутствующего файла
  • Доработан класс для управления импортом данных их CSV/Excel (спасибо МТС Пермь):
    • Теперь при импорте данных без идентификаторов (ID) удаляются все непосредственные подразделы только того же типа, что и импортируемые данные
    • Теперь при импорте данных без названий префикс из названия надраздела не подставляется

Zion WebEngine Zion Import CSV/Excel Импорт/Экспорт Классы Кэш/Кеш Файлы/Папки

Zion WebEngine X9.04.28
  • Доработано класс для управления контентом (спасибо Адель):
    • Устранена вероятность возникновения ошибок при попытке открыть на редактирование несуществующих записей

Zion WebEngine Классы Контент/Контентные единицы

Zion WebEngine X9.04.27
  • Доработано класс для управления базой данных (спасибо Адель):
    • Модальные окна добавления/клонирования, перемещения записи в указанное место и настройки фильтрации теперь открываются мнгновенно
    • Реализовано несколько автоматизаций, делающих добавление/клонирование записей более удобным и быстрым

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

Zion WebEngine X9.04.26
  • Доработано класс для управления базой данных (спасибо Адель):
    • Проверка на корректность указания ID при добавлении новой записи теперь работает более продуманно и эффективно

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

Zion WebEngine X9.04.24
  • Доработано меню администратора для Ядра (спасибо Адель):
    • Скрыты некоторые разделы, которых недолжно быть видно при определённом комплекте поставки
  • Устранена опечатка в помощнике по вставке плагина универсального меню

Zion WebEngine Что такое Комплект поставки? Меню/Списки/Навигация Меню администратора Плагины Помощники/Мастеры/Инструкции/Подсказки

Zion WebEngine X9.04.23
  • Доработан класс для управления проектом (спасибо МТС Пермь):
    • Из виджета на панели инструментов теперь выход производится не в новом, а в том же окне (в той же вкладке)
  • Доработан класс для управления заказами (спасибо Moto-Retail18):
    • Устранены проблемы с формированием номера нового заказа
  • Доработан класс для управления корзиной:
    • Реализована автоматическая очистка кэша CSS-оформления формы заказа

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

Zion WebEngine X9.04.22
  • Доработан класс для управления SMS-уведомлениями (спасибо Балкон Мастер):
    • Устранены недочёты в инструкции по настройке SMS-шлюза
  • Доработан импорт из CSV/Excel (спасибо МТС Пермь):
    • Учтены некоторые новые возможности различных компонентов, которые должны быть учтены при импорте данных
    • Реализована возможность импортировать данные без идентификаторов (ID):
      • При этом перед началом импорта автоматически удаляются все подразделы указанного надраздела (во избежании дублирования при каждом повторном импорте)
    • Реализована возможность импортировать данные без названий:
      • Названия записей при этом автоматически формируются из названия выбранного надраздела и заполненных полей (удобно, например, для импорта списка адресов)
  • Доработан класс для управления скидками (спасибо Moto-Retail18):
    • Устранена вероятность возникновения ошибки при заказе, если ни одна скидка не доступна

Zion WebEngine Zion Catalog Zion Import CSV/Excel SMS Импорт/Экспорт Классы Корзина для заказов Скидки/Наценки

Zion WebEngine X9.04.19
  • Доработан импорт из CSV/Excel (спасибо МТС Пермь):
    • Учтены некоторые новые возможности различных компонентов, которые должны быть учтены при импорте данных

Zion Import CSV/Excel Импорт/Экспорт

Zion WebEngine X9.04.18
  • В интернет-магазине расширены возможности управления автоматическими скидками (спасибо Белый и пушистый):
    • Доработан класс для управления скидками:
      • Учтена вероятность начисления сразу нескольких скидок
    • Доработаен класс для управления скидкой для зарегистрированных пользователей:
      • Расширены возможности отладки
    • Создан класс для управления скидкой при заказе на определённую сумму:
      • Учитывается полная стоимость всех товаров в корзине до начислении всех скидок
      • Не учитывается стоимость доставки и скидка/наценка за выбранный способ оплаты
    • Доработан класс для управления корзиной заказов:
      • Внесены некоторые коррективы
    • Доработан класс для управления заказами:
      • При включении уведомления о заказах в CMS информация о заказах в административном интерфейсе также будет видна с учётом скидок
  • Доработан импорт из 1С/XML:
    • Учтены некоторые новые возможности различных компонентов, которые должны быть учтены при импорте данных

Zion User Control Zion Catalog Zion Import Что такое CMS Zion WebEngine? XML/RSS/1С/YML Административный интерфейс Доступы/Пользователи Импорт/Экспорт Интернет-магазин Классы Корзина для заказов Реакции на заказ Скидки/Наценки Способы доставки/самовывоза Способы оплаты