Уведомления о событиях¶

Как добавить собственное событие¶

Все события, получатели и транспорты сообщений, зарегистрированные в системе, описаны в схеме notifications/events.php.

Схема доступна через сервис Tygh::$app['event.events_schema'].

Каждый элемент схемы имеет следующую структуру:

(string) EventId => [
    'group' => (string) GroupId,
    'name' => [
        'template' => (string) TemplateLanguageVariable,
        'params' => [
            (string) SubstitutionName => (string) Substitution
            ...
        ],
    ],
    'data_provider' => (callable) DataProvider,
    'receivers' => [
        (string) ReceiverId => [
            (string) TransportId => BaseMessageSchema::create([
                'area'            => (string) area,
                'from'            => (string) from,
                'to'              => (callable) DataValue::create(key),
                'template_code'   => (string) template_code,
                ...
                'language_code'   => (callable) DataValue::create(parent_key.key, default_value),
                'data_modifier'   => (callable) function (array $data) {
                    return array_merge($data, $added_data_value);
                }
            ]),
            ...
        ],
        ...
    ],
],

• EventId — идентификатор события. Он используется в качестве первого аргумента в \Tygh\Notifications\EventDispatcher::dispatch.
• GroupId — идентификатор группы событий. Он используется на странице настроек уведомлений, для более удобной навигации.
• TemplateLanguageVariable — имя языковой переменной, которая используется для обозначения события на странице настроек уведомлений.
• SubstitutionName и Substitution — имя и значение параметров, используемых для адаптации языковой переменной под особенности события.
• DataProvider — реализует интерфейс Notification\DataProviders\DataProvider используется для получения специфичных для события полей на основе data переданных в \Tygh\Notifications\EventDispatcher::dispatch.
• ReceiverId — идентификатор получателя. Все существующие в системе идентификаторы получателей могут быть получены из Tygh::$app['event.receivers_schema']
• TransportId — идентификатор транспорта. Транспорты должны предоставлять его в \Tygh\Notifications\Transports\ITransport::getId.
• BaseMessageSchema — Создает инстанс класса схемы, с подготовленными для отправки данными. Входящие параметры должны содержать преобразованные данные, которые необходимы для отправки уведомления. Могут быть представлены как текст (area, from, template_code) или как инстанс класса DataValue.
• DataValue - класс, позволяющий получить данные из входного массива по ключу. Если переданный ключ не содержится в массиве, то будет взято default_value, по умолчанию null.
• data_modifier — этот callable-параметр позволяет в рамках функции выполнить дополнительные преобразования полей, переданных в data .

Чтобы зарегистрировать событие:

1. Выберите уникальный идентификатор события (EventId).

2. Выберите, к какой группе событий новое событие относится.

   Если событие относится к новой группе — создайте языковую переменную с идентификатором, совпадающим с GroupId, и значением — названием группы событий.

3. Создайте языковую переменную, в которой хранится шаблон для формирования названия события (TemplateLanguageVariable).

4. Сформируйте список подстановок в шаблон названия события (SubstitutionName, Substitution).

   Если название события не имеет подстановок, массив 'params' должен быть оставлен пустым.

5. Укажите идентификаторы типов пользователей, которые должны получать уведомление о событии (ReceiverId).

6. Укажите название реализованного DataProvider для обработки специфичных для этого события данных, приходящих из data.

7. Для каждого типа получателей укажите:

   • каким образом им должны приходить уведомления (TransportId);
   • данные, специфичные для текущего получателя, и преобразованные в инстанс класса BaseMessageSchema (с использованием DataValue, если необходимо).

Как запустить событие¶

В тех местах, где требуется отправить уведомления, необходимо добавить вызов диспетчера событий:

Tygh::$app['event.dispatcher']->dispatch('EventId', ['order_info' => $order_info, 'user_info' => $user_info, 'settings' => $settings]);

Как добавить собственное сообщение¶

Чтобы добавить сообщение:

1. Добавьте провайдер для данных сообщения, реализующий интерфейс \Tygh\Notifications\DataProviders\IDataProvider или расширяющий существующий класс базового провайдера данных.
2. Укажите этот провайдер в схеме событий для конкретного транспорта.
3. Задайте в схеме событий правила для преобразования входящих данных, переданных в диспетчер.

Как добавить собственный транспорт¶

Список идентификаторов транспортов, использующихся в системе, доступен через сервис Tygh::$app['event.transports_schema'].

Чтобы добавить собственный транспорт:

1. Выберите идентификатор, под которым транспорт будет зарегистрирован в системе (TransportId).
2. Создайте класс, реализующий интерфейс \Tygh\Notifications\Transports\ITransport.
3. В методе getId() этого класса укажите выбранный идентификатор.
4. Зарегистрируйте провайдер данного транспорта в Tygh::$app['event.transports.{TransportId}'].
5. Создайте языковую переменную с идентификатором event.transport.TransportId и значением — названием транспорта.

Как добавить собственного получателя¶

Список идентификаторов получателей доступен через сервис Tygh::$app['event.receivers_schema'].

Чтобы добавить новый тип получателей:

1. Напишите обработчик хука get_notification_rules, добавив идентификатор получателя в массив $force_notification.
2. Создайте языковую переменную с идентификатором event.receiver.ReceiverId и значением — названием типа получателей.
3. Добавьте данных получателей в схему событий, указав транспорты, которыми данным получателям доставляются уведомления.

Перегрузка правил уведомлений¶

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

Набор перегрузок представляет из себя объект класса \Tygh\Notifications\Settings\Ruleset и создаётся фабрикой правил Tygh::$app['event.notification_settings.factory']. Набор перегрузок передается одним из параметров при запуске события.

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

$notification_rules = Tygh::$app['event.notification_settings.factory']->create([
    UserTypes::CUSTOMER => false,
    UserTypes::ADMIN    => true,
    UserTypes::VENDOR   => true,
]);

Tygh::$app['event.dispatcher']->dispatch(
    'order.updated',
    $order_info,
    $notification_rules
);