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

06.11.2023

Если инструкция не соответствует тому, что Вы видите, Ваша версия CMS устарела. Обратитесь к создателю сайта за обновлением...

Все плагины в CMS Zion WebEngine служат для выполнения каких-либо целей. Это может быть вывод какого-то текста, корректировка базы данных, изменение глобальных переменных и т.д.

Где хранятся плагины

Плагины могут быть самостоятельными программными модулями или могут быть частью классов

Каждый самостоятельный плагин хранится в одном из файлов в папке plugins, либо plugins/custom. Если Вы хотите изменить один из таких плагинов или создать новый, то сохраняйте его в папке plugins/custom - так он не будет заменён стандартным плагинов в случае обновления CMS. При совпадении имён в plugins и в plugins/custom наибольший приоритет имеют плагины из папки plugins/custom.
Если плагин является частью класса, то найти его можно в файле соответствующего класса. Это будет отдельный метод, имя которого всегда начинается с Plugin и в качестве параметров к которому должен передаваться массив params

Набор доступных плагинов зависит от комплекта поставки

Имена плагинов

Если плагин хранится в отдельном файле с имением мойплагин.php то имя плагина будет мойплагин (.php обязательно должно присутствовать в имени файла)
Если плагин является частью класса, например, мойкласс, и хранится в методе PluginМойПлагин, то имя плагина будет мойкласс_МойПлагин

К плагинам можно обращаться через команду вызова, через URL-адрес или через AJAX

В самом простом случае команда вызова плагина выглядит так: {plugin:мойплагин} или {plugin:мойкласс_МойПлагин}
При обращении через URL-адрес всё аналогично: /?plugin=мойплагин или /?plugin=мойкласс_МойПлагин (в URL также могут быть указаны другие GET-параматры, как слева, так и справа от того, что указано в примере)
При обращении через 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(...);

От способа вызова плагина зависит то, где и как будет выводиться его результат:

Если используется команда вызова плагина, то результат отобразится именно там, где была команда (результат заменит собой команду)
Если используется обращение по URL-адресу, то результат выведется в браузере (при этом на веб-странице не будет ничего кроме результата выполнения плагина)
Если используется вызов через AJAX, то результат будет выведен в тег, свойство id которого совпадает с тем, что указано в objectID

Параметры плагинов

Плагинам можно передавать параметры. В результате многие плагины могут выполняться в сотнях и в тысячах различных режимов

Если используется команда вызова плагина, то она может выглядеть, например, так: {plugin:имя_плагина;color:red;type:apple;action:kick}, при этом
- после имени плагина должна быть точка с запятой;
- пары имя-значение (имя и значение параметра) отделяются друг от друга точкой с запятой;
- имя параметра от значения того же параметра отделяется двоеточием:
- в именах и в значениях параметров не допускается использовать двоеточия: и точки с запятой;
Если используется обращение по URL-адресу, то для того же плагина с теми же параметрами URL будет такой: /?plugin=имя_плагина&params=color:red;type:apple;action:kick}, при этом
- после имени плагина нужно написать &params=
- пары имя-значение (имя и значение параметра) также отделяются друг от друга точкой с запятой;
- имя параметра от значения того же параметра также отделяется двоеточием:
- в именах и в значениях параметров не допускается использовать двоеточия: и точки с запятой;, а также амперсанд& и равно=
Если используется вызов через AJAX, то к URL применяются те же требования, что и в предыдущем примере

В плагине эти параметры можно использовать, как элементы ассоциативного массива $params. Например, параметры из примеров выше будут доступны, как переменные $params['color'], $params['type'] и $params['action'].

Плагины могут воспринимать только те параметры, которые в них запрограммированы. Список доступных параметров смотрите в документации к каждому конкретном плагину

Что такое Комплект поставки? AJAX POST/GET-данные Адрес (URL)/ЧПУ/Переадресация Классы Обновления CMS Плагины Элемент "HTML-код веб-страницы" Элемент "Адрес" Элемент "Место в структуре"

CMS Zion WebEngine является бесплатной системой. Развивается за счёт рекламы, помощи веб-студии #webZion и других спонсоров.

Будем рады, если Вы поддержите нас любой суммой, а также поделитесь идеями на счёт каких-либо улучшений и доработок для CMS...

Заранее, большое, спасибо

Блог обновлений

DEKO WebEngine 3.3.2.1

Улучшена интеграция объявлений с редакторами контента
Улучшена интеграция новостей с редакторами контента
Улучшена интеграция товаров с редакторами контента
Устранена проблема с кодировкой в редакторе контента FCKeditor
Значительно оптимизирована работа с базами данных в DataBase Driver 1.4 засчёт внедрения четырёхуровнего кеширования (спасибо SuperMaf)
Исправлена ошибка в отображении справочной информации о меню (спасибо PartAll)
Снят ряд ограничений на набор символов, допустимых для указания в логине и пароле администратора
В Converter Driver 1.1.16.2 доработано несколько функций конвертации текста
В Wrapper Driver 1.0.48.1 доработано создание ссылок на главную страницу
Улучшено кэширование графических, текстовых и HTML-файлов, а также CSS-стилей и JS-скриптов на стороне веб-браузера, что значительно снижает нагрузку на веб-сервер
Улучшена интеграция баннеров с редакторами контента
В плагине Share 1.0.1.1 стало доступно использование ещё нескольких социальных кнопок
Мастер для вставки плагина Share доработан под обновившийся функционал плагина
Улучшена интеграция статей с редакторами контента
Произведён возврат к более старой версии KCAPTCHA 1.2.6, как к более стабильной

Zion WebEngine Zion Catalog Zion SEO Booster Zion Bulletins Board KCAPTCHA Zion Edition Zion Articles Tree Zion News Line FCKeditor Zion Edition Адрес (URL)/ЧПУ/Переадресация База данных/Таблицы данных Баннеры Веб-браузер Веб-сервер/Хостинг Доступы/Пользователи Драйверы Кодировки/Наборы символов Контент/Контентные единицы Кэш/Кеш Меню/Списки/Навигация Объявления Плагины Помощники/Мастеры/Инструкции/Подсказки Редактор контента/WYSIWYG-редактор Сайт-каталог Спам

Zion WebEngine 3.3.2

Сделано множество улучшений и доработок ядра, SEO-оптимизации, формы обратной связи, доски объявлений и KCAPTCHA

Zion WebEngine Zion Mail Back Zion SEO Booster Zion Bulletins Board KCAPTCHA Zion Edition SEO-параметры Объявления Обратная связь/Обратный звонок Спам Формы

DEKO WebEngine 3.3.1.10

Реализовано несколько оптимизаций для Каталога товаров, Ядра, Доски объявлений и Дерева статей

Zion WebEngine Zion Catalog Zion Bulletins Board Zion Articles Tree Контент/Контентные единицы Объявления Сайт-каталог

DEKO WebEngine 3.3.1.9

Устранена ошибка при использовании HTML5 в плагине NewsLine 1.2.13

Zion News Line Контент/Контентные единицы Меню/Списки/Навигация Плагины

DEKO WebEngine 3.3.1.8

Cтандартизирован и внедрён в пакет Каталога товаров ранее созданный набор плагинов и обработчиков для реализации функций онлайн-заказов, что позволяет создавать интернет-магазины стандартными средствами движка

Zion Catalog Интернет-магазин Корзина для заказов Обработчики Плагины Сайт-каталог

DEKO WebEngine 3.3.1.7

Устранена ошибка в плагине Mailback 1.2.7 (спасибо TradeRing)

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

DEKO WebEngine 3.3.1.6

Устранена опечатка в системе мониторинга для формы обратной связи

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

DEKO WebEngine 3.3.1.5

В плагинах NewsLine 1.2.12 и NewsMenu 1.0.49.1 изменено значение по умолчанию для параметра defaulticon (эскиз по умолчанию) с hide (скрывать), на show (показывать)
Мастеры вставки плагинов NewsLine и NewsMenu доработаны для последних изменений в плагинах
В комплект поставки пакета News Line включено несколько заготовок баз данных и настроек для более быстрого и удобного управления оформлением новостей
Доработана система мониторинга новостей для автоматической подстановки заготовок баз данных и настроек при их отсутствии
Исправлены недоработки при использовании семантики HTML5 в плагинах NewsLine, NewsMenu и NewsCatMenu 1.0.23.1, а также в мастерах для вставки этих плагинов
В плагинах Catalog 1.1.4 и CatalogMenu 1.1.4.2 изменено значение по умолчанию для параметра defaulticon (эскиз по умолчанию) с hide (скрывать), на show (показывать)
Исправлены недоработки при использовании семантики HTML5 в плагинах Catalog, CatalogCatMenu, CatalogGroupPropMenu 1.1.2, CatalogMenu 1.1.5.1, CatalogPropMenu 1.1.3
В плагинах ArticlesTree 1.0.40.3 и ArticlesMenu 1.0.34.1 изменено значение по умолчанию для параметра defaulticon (эскиз по умолчанию) с hide (скрывать), на show (показывать)
Мастеры вставки плагинов ArticlesTree и ArticlesMenu доработаны для последних изменений в плагинах
Исправлены недоработки при использовании семантики HTML5 в плагинах ArticlesTree, ArticlesMenu и ArticlesCatMenu 1.0.23.2, а также в мастерах для вставки этих плагинов
В комплект поставки пакета Articles Tree включено несколько заготовок баз данных и настроек для более быстрого и удобного управления оформлением статей
Доработана система мониторинга данного пакета для автоматической подстановки заготовок баз данных и настроек при их отсутствии
В плагине ArticlesTree изменены значения по умолчанию для параметров mode (теперь равно only (показывать статьи только из указанной категории)) и sub (теперь равно show (показывать статьи из подкатегорий для выбранной категории))
Мастер вставки плагина ArticlesTree доработан для соответствия последним изменениям в плагине
В обработчике сохранения настроек CSS для редактора контента FCKeditor исправлена некорректная обработка некоторых символов (спасибо ТрэйдРинг)

Zion Catalog Zion Articles Tree Zion News Line FCKeditor Zion Edition База данных/Таблицы данных Категории Контент/Контентные единицы Меню/Списки/Навигация Мониторинг Плагины Помощники/Мастеры/Инструкции/Подсказки Редактор контента/WYSIWYG-редактор Сайт-каталог Характеристики/Разновидности

DEKO WebEngine 3.3.1.4

Доработаны настройки по умолчанию для Каталога товаров
Доработано несколько форм из пакета Каталога товаров
Доработаны настройки по умолчанию для Дерева статей
Доработано несколько форм из пакета Дерева статей
Доработана справочная система для FCKeditor
Доработано Меню администратора для FCKeditor
Создана возможность изменять CSS-настройки для редактора контента FCKeditor через Интерфейс администратора
Доработано несколько форм из пакета Менеджера баннеров
Доработана справочная система для CKeditor
Доработано Меню администратора для CKeditor

Zion Catalog Zion Banners Manager Zion Articles Tree CKeditor Zion Edition FCKeditor Zion Edition Административный интерфейс Баннеры Контент/Контентные единицы Меню администратора Помощники/Мастеры/Инструкции/Подсказки Редактор контента/WYSIWYG-редактор Сайт-каталог Формы

DEKO WebEngine 3.3.1.3

Устранена частичная несовместимость нескольких форм из пакета Articles Tree с некоторыми браузерами
Устранена частичная несовместимость нескольких форм из пакета Banners Manager с некоторыми браузерами

Zion Banners Manager Zion Articles Tree Баннеры Веб-браузер Контент/Контентные единицы Меню/Списки/Навигация Формы

DEKO WebEngine 3.3.1.2

Несколько форм пакета Mail Back доработано для совместимости с большим количеством браузеров
Несколько форм пакета Banners Manager доработано для совместимости с большим количеством браузеров

Zion Mail Back Zion Banners Manager Баннеры Веб-браузер Обратная связь/Обратный звонок Формы

DEKO WebEngine 3.3.1.1

Сделано множество улучшений и доработок для Дерева статей, Доски объявлений, Ядра, Каталога товатор, Ленты новостей, Автоматической SEO-оптимизации

Zion WebEngine Zion Catalog Zion SEO Booster Zion Bulletins Board Zion Articles Tree Zion News Line SEO-параметры Контент/Контентные единицы Объявления Сайт-каталог

DEKO WebEngine 3.3.1

Повышена безопасность для Поиска, Ленты новостей, Каталога товаров, Ядра, Доски объявлений, Дерева статей

Zion WebEngine Zion Catalog Zion SEO Booster Zion Bulletins Board Zion Articles Tree Zion News Line Контент/Контентные единицы Объявления Поиск текста Сайт-каталог

DEKO WebEngine 3.3

Выполнены незначительные доработки в ряде графических компонентов Lightbox
Расширен набор доступных шрифтов для FCKeditor
В плагине FCK CSS 1.0.3 исправлена ошибка недопроверки на необходимость запросов к плагинам и на необходимость подстановки свойств объектов
Выполнены незначительные доработки в ряде программных компонентов FCKeditor
Внедрена CSS-поддержка семантических тегов HTML5
Улучшена интерграция редактора FCKeditor с Lightbox: FCKeditor обучен учитывать возможность немоментальной загрузки Lightbox, и, как следствие, его некорректной работы
Все необходимые формы пакета Banners Manager доработаны для обеспечения возможности использования общих форм вставки мастеров
В форме редактирования баннера устранены орфографические ошибки
В плагине CK CSS 1.0.3 исправлена ошибка недопроверки на необходимость запросов к плагинам и на необходимость подстановки свойств объектов
Выполнены незначительные доработки в ряде программных компонентов CKeditor

Zion Banners Manager Lightbox Zion Edition CKeditor Zion Edition FCKeditor Zion Edition Баннеры Галереи/Слайды Плагины Помощники/Мастеры/Инструкции/Подсказки Редактор контента/WYSIWYG-редактор Свойства Формы

DEKO WebEngine 3.2.9.1

Система мониторинга для Lighbox теперь умеет автоматически вставлять плагин Lightbox Includer 1.0.4 в шаблоны страниц, если это необходимо
В системе мониторинга для Lighbox доработано указание параметров по умолчанию
В системе мониторинга для KCAPTCHA доработано указание параметров по умолчанию
В системе мониторинга для CKeditor доработано указание параметров по умолчанию
Доработан плагин CK CSS 1.0.2

Lightbox Zion Edition KCAPTCHA Zion Edition CKeditor Zion Edition Галереи/Слайды Контент/Контентные единицы Мониторинг Плагины Редактор контента/WYSIWYG-редактор Спам Шаблоны контента