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

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 23.05.15
  • Доработан класс для управления базой данных (спасибо ТК Кило):
    • Устранены некоторые недочёты с ограничением доступа для разных групп пользователей

Zion WebEngine База данных/Таблицы данных Доступ Групп пользователей Классы Что такое Классы?

Zion WebEngine 23.05.12
  • Доработаны элемент Связи и административные скрипты (спасибо ТК Кило):
    • Заверено внедрение функционала, позволяющего добавить описание к каждой связи между контентными единицами
    • Разработка завершена, но развитие этого функционала ещё возможно в ближайших обновлениях
  • Доработан главный файл гостевого интерфейса:
    • Упрощено включение/выключения отображения ошибок - может быть полезно при отладке PHP-кода

Zion WebEngine Что такое Административный интерфейс и Гостевой интерфейс? PHP Контент/Контентные единицы Обновления CMS Связи Элементы

Zion WebEngine 23.05.02
  • Доработаны элемент Связи и административные скрипты (спасибо ТК Кило):
    • Начато внедрение функционала, позволяющего добавить описание к каждой связи между контентными единицами
    • Разработка ещё не завершена
  • Доработаны класс для управления контентом и плагин универсального меню:
    • Добавлен новый параметр reason, доступный при отображение связанных контентных единиц:
      • При пустом или не указанном значении будут отображены все связи с учётом других параметров фильтрации (как и раньше - по умолчанию)
      • При значении !exists будут выведены только те записи, для которых причина связи указана (не является пустой/нулевой)
      • При значении !notexists будут выведены только те записи, для которых причина связи не указан (является пустой/нулевой)
      • При другом значении будут выведены только те записи, для которых причина связи равна этому значению
  • Доработан главный файл административного интерфейса:
    • Упрощено включение/выключения отображения ошибок - может быть полезно при отладке PHP-кода

Zion WebEngine PHP Административный интерфейс Классы Контент/Контентные единицы Меню/Списки/Навигация Плагины Связи Элементы

Zion WebEngine 23.04.27
  • Доработан плагин формы обратной связи (спасибо МедИнвест):
    • Устранены некоторые рудимент по части защиты от спама и интеграции с почтовыми клиентами

Zion Mail Back Обратная связь/Обратный звонок Плагины Спам Формы Что такое Плагины?

Zion WebEngine 23.04.26
  • Доработан плагин Meta (спасибо Moto-Retail18):
    • Теперь для страниц с подстраницами (с пагинацией) в заголовок и в описание автоматически добавляется номер активной подстраницы:
      • Это избавляет от проблемы с одинаковыми заголовками и описаниями и положительно сказывается на SEO-оптимизации

Zion SEO Booster SEO-параметры Пагинация/Подстраницы Плагины Как оптимизировать сайт под поисковые системы?

Zion WebEngine 23.04.25
  • Доработан элемент Связи (спасибо ТК Кило):
    • Реализовано сохранение внедрённых в недавних обновлениях данных о причинах связи при клонировании записи
  • Доработан класс для управления базой данных:
    • Реализованы разрешение и запрет на клонирование записей для каждой отдельной группы пользователей:
      • Для администраторов такая возможность есть всегда
      • Для других групп пользователей этот параметр настраивается, и по умолчанию доступ к данной функции запрещён

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

Zion WebEngine 23.04.21
  • Доработан элемент Связи (спасибо ТК Кило):
    • Завершено внедрение функционала, позволяющего не только связывать контентные единицы друг с другом, но и выбирать один из доступных вариантов причин связи:
      • Можно использовать, как уже имеющиеся варианты, так и добавлять новые
      • Неиспользуемые варианты удаляются автоматически
      • Устранены недочёты, выявленные в предыдущей версии
      • Разработка завершена

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

Zion WebEngine 23.04.14
  • Доработан элемент Многострочное поле с редактором (спасибо МедИнвест):
    • Теперь в соответствующее поле войдёт значительно больше текста

Zion WebEngine Многострочные поля Элементы Что такое Элементы?

Zion WebEngine 23.04.10
  • Доработан обработчик обратной связи (спасибо МедИнвест):
    • Устранены проблемы при отправке email-сообщений

Zion Mail Back Email-сообщения Обработчики Обратная связь/Обратный звонок

Zion WebEngine 23.04.07
  • Доработан класс для создания YML-фида для Яндекс.Маркет, Яндекс.Директ и Яндкекс.Вемастер (спасибо Moto-Retail18):
    • Теперь данные о наличии/отсутствии товара передаются в соответствии с новыми требованиями Яндекс.Вебмастер
    • Теперь, если не заполнено описание для Яндекс.Маркет, оно формируется из основного текста:
      • А если и основной текст не заполнен, то описание берётся из названия товара

Zion Export XML/RSS/1С/YML Классы Основной текст Сайт-каталог Элемент "Основной текст"

Zion WebEngine 23.04.06
  • Доработан плагин универсального меню (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Теперь поиск не приводит к ошибке при использовании параметра select со значением all, если в комплекте поставки нет тех или иных пакетов
  • Доработан класс для создания YML-фида для Яндекс.Маркет, Яндекс.Директ и Яндкекс.Вемастер (спасибо Moto-Retail18):
    • Теперь пробелы в адресах изображений автоматически конвертируются в необходимый спецсимвол %20 для успешного прохождения модерации в данных веб-сервисах Яндекса

Zion WebEngine Zion Export Что такое Комплект поставки? XML/RSS/1С/YML Классы Кодировки/Наборы символов Меню/Списки/Навигация Плагины Поиск текста

Zion WebEngine 23.04.05
  • Доработан элемент Расписание (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Устранены проблемы с сохранением данных, переданных пользователем при бронировании
  • Доработан файл-менеджер (спасибо Федерация Киокушин России):
    • Устранены проблемы с загрузкой больших файлов на веб-сервер

Zion WebEngine Zion Booking Бронирование/Расписание Веб-сервер/Хостинг Классы Файл-менеджер Файлы/Папки Элементы Что такое Элементы?

Zion WebEngine 23.04.04
  • Доработан класс для управления числами (спасибо Good Авто):
    • Создан новый плагин {number_ToFloat}, приводящий любое переданное в него значение к вещественному числу (или к нулю)
  • Доработан класс для управления водяными знаками (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Устранена проблема с возвращением некорректного адреса изображения

Zion WebEngine Zion Gallery Адрес (URL)/ЧПУ/Переадресация Изображение Классы Плагины Число Что такое Плагины?

Zion WebEngine 23.04.03
  • Доработан класс для управления базой данных (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Теперь в форме добавления новой записи в режиме клонирования: кнопка Добавить будет оставаться недоступной, пока не загрузится список оригиналов, доступных для клонирования

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

Zion WebEngine 23.03.30
  • Доработан класс для управления шаблонами (спасибо Федерация Киокушин России):
    • Устранена проблема, из-за которой при при правке контента в административном интерфейсе могли не отображаться те или иные элементы

Zion WebEngine Административный интерфейс Классы Контент/Контентные единицы Шаблоны контента Элементы Что такое Шаблон контента?

Zion WebEngine 23.03.24
  • Доработан класс для управления галереями (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Теперь на больших экранах со слайдами в галерее работать стало удобнее, чем раньше, за счёт более продуманного расположения элементов административного интерфейса
  • Доработан класс для управления базой данных:
    • Устранена проблема, из-за которой при добавлении новой записи в подразделах раздела Контент административного интерфейса выбранное значение для списка Место в структуре игнорировалось

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

Zion WebEngine 23.03.22
  • Доработан класс для управления галереями (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Устранена проблема с отображением текста на кнопке для вставки слайда в режиме Всё в одном поле в случае, если для галереи доступно сразу несколько режимов

Zion Gallery Галереи/Слайды Классы Что такое Классы?

Zion WebEngine 23.03.21
  • Доработан класс для управления базой данных (спасибо СП МАОУ "СОШ 118" г. Перми):
    • Устранена проблема с отображением веб-шрифта на некоторых кнопках в административном интерфейсе

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

Zion WebEngine 23.03.16
  • Доработаны обработчики обратной связи и обратного звонка:
    • Повышена защита от спама

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

Zion WebEngine 23.03.13
  • Доработан класс для управления парсингом стороннего сайта (спасибо Moto-Retail18):
    • Внесены некоторые коррективы в алгоритм восстановления снова нужных товаров

Zion Import Импорт/Экспорт Классы Сайт-каталог Что такое Классы?