События плагина

События плагина

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

Описание событий

OnCommerceDeliveryGoshippoBeforeMarkupRender

Вызывается перед генерацией блока из полями для ввода адреса, позволяет добавить свои данные или переопределить текущие.

Параметры:

Имя параметра	Передается по ссылке	Описание
data	Да	Массив с данными, которые передаются в шаблон

switch ($modx->event->name) {
    case 'OnCommerceDeliveryGoshippoBeforeMarkupRender':
    $params['data']['myField'] = 'test1234';
    break;
}

OnCommerceDeliveryGoshippoAddressReceived

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

Параметры:

Имя параметра	Передается по ссылке	Описание
address	Да	Адрес, который получим из запроса. fields Поля которые будут переданы в goshippo для получения тарифов full Флаг, который означает что адрес полностью заполнен, и можно запросить тарифы requireState Флаг, который означает что для данного адреса обязательн заполнить штат
type	нет	Тип адреса, destination - получатель,sender - отправитель

switch ($modx->event->name) {
    case 'OnCommerceDeliveryGoshippoAddressReceived':
        $params['address']['full'] = true;
        break;
}

OnCommerceDeliveryGoshippoParcelsCalculate

Вызывается после расчета габаритов поссылок, позволяет изменить габариты.

Параметры:

Имя параметра	Передается по ссылке	Описание
items	Нет	Массив товаров
parcels	Да	Масив поссылок и их габаритов

switch ($modx->event->name) {
    case 'OnCommerceDeliveryGoshippoParcelsCalculate':
        foreach ($params['parcels'] as $key =>  $parcel) {
            $params['parcels'][$key]['weight']  = $parcel['weight'] * 0.1;
        }
    break;
}

OnCommerceDeliveryGoshippoBeforeRatesCalculate

Вызывается перед получением тарифов, позволяет изменить данные которые передаются в апи для расчета тарифов доставки.

Параметры:

Имя параметра	Передается по ссылке	Описание
address_from	Да	Адрес отправителя
address_to	Да	Адрес получателя
parcels	Да	Габариты посылок

OnCommerceDeliveryGoshippoRatesCalculate

Вызывается после получением тарифов, позволяет изменить список и параметры тарифов (заголовок, цена и т.д.)

Параметры:

Имя параметра	Передается по ссылке	Описание
address_from	Нет	Адрес отправителя
address_to	Нет	Адрес получателя
parcels	Нет	Габариты посылок
rates	Да	Тарифы

switch ($modx->event->name) {
    case 'OnCommerceDeliveryGoshippoRatesCalculate':
        foreach ($params['rates'] as $key => $rate) {
            if($rate['provider'] !=='USPS'){
                unset($params['rates'][$key]);
            }
        }
        break;
}

OnCommerceDeliveryGoshippoBeforeInvoiceCreate

Вызывается перед генерацией накладной, позволяет отменить генерацию или изменить параметры передаваемые в апи.

Параметры:

Имя параметра	Передается по ссылке	Описание
order	Нет	Данные заказа
rate	Нет	Данные выбранного тарифа
request_params	Да	Параметры передаваемые в апи
prevent	Да	Флаг отмены генерации накладной

OnCommerceDeliveryGoshippoInvoiceCreate

Вызывается после генерацией накладной.

Имя параметра	Передается по ссылке	Описание
order	Нет	Данные заказа
rate	Нет	Данные выбранного тарифа
transaction	Да	Данные о накладной