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

[Гончаров Игорь]

Плагином мы называем набор файлов, организованных по определенным правилам и добавляющих или меняющих логику работы платформы.

Для простоты понимания рассмотрим пример плагина ItemTargetBlank.
Стояла задача: все ссылки на товары, открывать в новой вкладке, по аналогии с сайтом https://www.taobao.com/

Структура файлов:
packages/
НзаваниеПлагина (основная папка с файлами плагина, например ItemTargetBlank)
- НзаваниеПлагинаPlugin.class.php (основной класс плагина, например ItemTargetBlankPlugin.class.php)
- config (папка содержащая конфигурационный файл плагина)
-- config.xml (файл конфигурации плагина)

Для активации плагина, необходимо поместить основную папку плагина в папку packages, например /packages/ItemTargetBlank/ .

Файл config.xml имеет вид:

<?xml version="1.0" encoding="UTF-8"?>
<plugin>
    <title>Открыть товар в новой вкладке</title>
    <description>Все ссылки на товары будут открываться в новой вкладке (по аналогии с сайтом taobao)</description>
    <version>1.0.0</version>
    <events>
        <event name="onAfterRenderFooter" />
    </events>
</plugin>

Все узлы конфигурации интуитивно поняты. Отдельно остановлюсь на узле events. Узел содержит список событий, при которых будет вызван наш плагин. В примере это только одно событие "onAfterRenderFooter" (выводит результат плагина в после подвала сайта).

Основная логика плагина содержится в файле ItemTargetBlankPlugin.class.php. Мы постарались минимизировать навязываемые стандарты к написанию данного файла. Вот ряд правил, которые необходимо соблюдать:
- класс должен называться по названию НзаваниеПлагинаPlugin (например ItemTargetBlankPlugin)
- класс должен быть унаследован от GeneralPlugin

Класс плагина содержит методы, название которых соответствует названию событий заявленных в файле конфигурации. Например:
public function onAfterRenderFooter($vars = array()) { ... }
Класс плагина может содержать метод public function renderPluginPage($request) - метод должен вернуть html. Этот html будет отображен администратору сайта в админке сайта. На самом деле в этом методе можно организовать свой роутинг и сделать админку внутри админки. Все ограничено лишь Вашей фантазией.



Рецепты:
- Если администратор сайта изменяет статус строки заказа на "Готово к отправке", необходимо отправить sms уведомление покупателю.

[Гончаров Игорь]

Дорогие друзья. Задавайте свои вопросы в комментариях к данной теме. По мере возможности буду отвечать и развивать данную тему, добавляя больше интересной информации и примеров.

Спасибо.

[Гончаров Игорь]

В обновлении 1.7.13 добавились новые события плагинов для работы с вызовом otapi.

Рассмотрим простую, но универсальную задачу: если администратор сайта изменяет статус строки заказа на "Готово к отправке", необходимо отправить sms уведомление покупателю.

Пример решения задачи.

Для начала добавляем использование необходимых нам событий в config.xml:
onOtapilibAfterGetDataНазваниеМетода - постобработка ответа при вызове сервисов из /otapilib.php
- onOtapilibAfterGetDataChangeLineStatus
- onOtapilibAfterGetDataUpdateOrderLineForOperator
- onOtapilibAfterGetDataUpdateOrderLinesForOperator
onAbstractOTAPILib2AfterCatchResponseНазваниеМетода - постобработка ответа при вызове сервисов из /otapilib2/OTAPILib2.php
- onAbstractOTAPILib2AfterCatchResponseChangeLineStatus
- onAbstractOTAPILib2AfterCatchResponseUpdateOrderLineForOperator
- onAbstractOTAPILib2AfterCatchResponseUpdateOrderLinesForOperator

Теперь в плагине делаем обработку каждого объявленного события.
По условию нашей задачи изменение статуса должно обрабатываться только для статуса "Готово к отправке" (Id=8). Поэтому добавляем дополнительное условие и при его срабатывании по номеру заказа получаем информацию о заказе, а затем и информацию о пользователе. Формируем и отправляем смс через удобный для нас сервис.

Замечания:
- событие onAbstractOTAPILib2AfterCatchResponseНазваниеМетода будет вызвано только при успешном ответе от сервисов, что позволяет пропустить проверку ответа от сервисов. В случае с событием onOtapilibAfterGetDataНазваниеМетода требуется добавить проверку на то, что сервисы успешно изменили статус строки заказа без ошибок: <ErrorCode>Ok</ErrorCode>.