[СДЕЛАЙ САМ] Промокоды для minishop2 с помощью MIGX.

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

Нам понадобится:
1. minshop2;
2. MIGX;
3. msOrderDiscount (если хотите после оформления заказа менять размер скидки);

Начнём с того, что создадим новую конфигурацию в компоненте MIGX с названием promocode со следующими полями:
1. code — сюда будем записывать сам промокод;
2. count — доступное количество активаций;
3. date — дата окончания срока действия;
4. percent — процент скидки;
Для ленивых прилагаю json с конфигурацией.

{
  "formtabs":[
    {
      "MIGX_id":28,
      "caption":"",
      "print_before_tabs":"0",
      "fields":[
        {
          "MIGX_id":106,
          "field":"code",
          "caption":"\u041f\u0440\u043e\u043c\u043e\u043a\u043e\u0434",
          "description":"",
          "description_is_code":"0",
          "inputTV":"",
          "inputTVtype":"",
          "validation":"",
          "configs":"",
          "restrictive_condition":"",
          "display":"",
          "sourceFrom":"config",
          "sources":"",
          "inputOptionValues":"",
          "default":"",
          "useDefaultIfEmpty":"0",
          "pos":1
        },
        {
          "MIGX_id":107,
          "field":"count",
          "caption":"\u041a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u043e \u0430\u043a\u0442\u0438\u0432\u0430\u0446\u0438\u0439",
          "description":"",
          "description_is_code":"0",
          "inputTV":"",
          "inputTVtype":"",
          "validation":"",
          "configs":"",
          "restrictive_condition":"",
          "display":"",
          "sourceFrom":"config",
          "sources":"",
          "inputOptionValues":"",
          "default":"",
          "useDefaultIfEmpty":"0",
          "pos":2
        },
        {
          "MIGX_id":108,
          "field":"date",
          "caption":"\u0414\u0430\u0442\u0430 \u043e\u043a\u043e\u043d\u0447\u0430\u043d\u0438\u044f",
          "description":"",
          "description_is_code":"0",
          "inputTV":"",
          "inputTVtype":"date",
          "validation":"",
          "configs":"",
          "restrictive_condition":"",
          "display":"",
          "sourceFrom":"config",
          "sources":"",
          "inputOptionValues":"",
          "default":"",
          "useDefaultIfEmpty":"0",
          "pos":3
        },
        {
          "MIGX_id":109,
          "field":"percent",
          "caption":"\u041f\u0440\u043e\u0446\u0435\u043d\u0442 \u0441\u043a\u0438\u0434\u043a\u0438",
          "description":"\u043f\u0440\u043e\u0441\u0442\u043e \u0447\u0438\u0441\u043b\u043e",
          "description_is_code":"0",
          "inputTV":"",
          "inputTVtype":"",
          "validation":"",
          "configs":"",
          "restrictive_condition":"",
          "display":"",
          "sourceFrom":"config",
          "sources":"",
          "inputOptionValues":"",
          "default":"",
          "useDefaultIfEmpty":"0",
          "pos":4
        }
      ],
      "pos":1
    }
  ],
  "contextmenus":"",
  "actionbuttons":"",
  "columnbuttons":"",
  "filters":"",
  "extended":{
    "migx_add":"",
    "disable_add_item":"",
    "add_items_directly":"",
    "formcaption":"",
    "update_win_title":"",
    "win_id":"",
    "maxRecords":"",
    "addNewItemAt":"bottom",
    "media_source_id":"",
    "multiple_formtabs":"",
    "multiple_formtabs_label":"",
    "multiple_formtabs_field":"",
    "multiple_formtabs_optionstext":"",
    "multiple_formtabs_optionsvalue":"",
    "actionbuttonsperrow":4,
    "winbuttonslist":"",
    "extrahandlers":"",
    "filtersperrow":4,
    "packageName":"",
    "classname":"",
    "task":"",
    "getlistsort":"",
    "getlistsortdir":"",
    "sortconfig":"",
    "gridpagesize":"",
    "use_custom_prefix":"0",
    "prefix":"",
    "grid":"",
    "gridload_mode":1,
    "check_resid":1,
    "check_resid_TV":"",
    "join_alias":"",
    "has_jointable":"yes",
    "getlistwhere":"",
    "joins":"",
    "hooksnippets":"",
    "cmpmaincaption":"",
    "cmptabcaption":"",
    "cmptabdescription":"",
    "cmptabcontroller":"",
    "winbuttons":"",
    "onsubmitsuccess":"",
    "submitparams":""
  },
  "permissions":"",
  "fieldpermissions":"",
  "columns":[
    {
      "MIGX_id":1,
      "header":"\u041f\u0440\u043e\u043c\u043e\u043a\u043e\u0434",
      "dataIndex":"code",
      "width":"",
      "sortable":"false",
      "show_in_grid":1,
      "customrenderer":"",
      "renderer":"",
      "clickaction":"",
      "selectorconfig":"",
      "renderchunktpl":"",
      "renderoptions":"",
      "editor":"this.textEditor"
    },
    {
      "MIGX_id":2,
      "header":"\u041a\u043e\u043b\u0438\u0447\u0435\u0441\u0442\u0432\u043e \u0430\u043a\u0442\u0438\u0432\u0430\u0446\u0438\u0439",
      "dataIndex":"count",
      "width":"",
      "sortable":"false",
      "show_in_grid":1,
      "customrenderer":"",
      "renderer":"",
      "clickaction":"",
      "selectorconfig":"",
      "renderchunktpl":"",
      "renderoptions":"",
      "editor":"this.textEditor"
    },
    {
      "MIGX_id":3,
      "header":"\u0414\u0430\u0442\u0430 \u043e\u043a\u043e\u043d\u0447\u0430\u043d\u0438\u044f",
      "dataIndex":"date",
      "width":"",
      "sortable":"false",
      "show_in_grid":1,
      "customrenderer":"",
      "renderer":"this.renderDate",
      "clickaction":"",
      "selectorconfig":"",
      "renderchunktpl":"",
      "renderoptions":"",
      "editor":"this.textEditor"
    },
    {
      "MIGX_id":4,
      "header":"\u041f\u0440\u043e\u0446\u0435\u043d\u0442 \u0441\u043a\u0438\u0434\u043a\u0438",
      "dataIndex":"percent",
      "width":"",
      "sortable":"false",
      "show_in_grid":1,
      "customrenderer":"",
      "renderer":"",
      "clickaction":"",
      "selectorconfig":"",
      "renderchunktpl":"",
      "renderoptions":"",
      "editor":"this.textEditor"
    }
  ],
  "category":""
}

Теперь у ресурса с id=1 создадим поле типа migx с названием promocodes и установим для него только что созданную конфигурацию.

Затем напишем сниппет validatePromocode, который будет проверять валидность введенного промокода

<?php
if(!$value){return false;}
$res = $modx->getObject('modResource', 1); // получаем ресурс, у которого есть поле с промокодами
$allCodes = json_decode($res->getTVValue('promocodes'),1); // получаем поле с промокодами
$isset = false; // флаг существования промокода 
$output = '';
    
foreach($allCodes as $key => $item){
    if($item['code'] == trim($value)){ // если текущий промокод равен введённому
        $isset = true;
        $now = time(); // текущее время в UNIX формате
        $date = strtotime($item['date']) ?: $now; // дата окончания срока действия промокода, если не указана промокод действует вечно
        if(($date - $now) < 0){ // если срок действия введённого промокода закончился
            return  'Истёк срок действия промокода.';      
        }
        if($item['count'] <= 0){ // если количество акциваций равно 0
            return  'Превышен лимит активаций.';    
        }
        if($changeCount === true){
            $allCodes[$key]['count'] = (($item['count'] - 1) > 0) ? ($item['count'] - 1) : 0; // уменьшаем количество на единицу
            $res->setTVValue('promocodes', json_encode($allCodes, JSON_UNESCAPED_UNICODE)); // сохраняем новые значения промокодов в TV
            $res->save(); // сохраняем ресурс
        }
        return array('percent'=> $item['percent'], 'value' => $value); // массив возвращаемых из плагина данных
    }
}
    
if(!$isset){ // если введённого промокода нет среди созданных админом
    return  'Несуществующий промокод.'; 
}

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

<?php
if($key == 'promocode'){ // если ввели промокод
    $result = $modx->runSnippet('validatePromocode', array('value' => $value));
    if(!is_array($result)){ // если есть ошибки
       $modx->event->output($result);
    }
    $values = & $modx->event->returnedValues; // х.з. как это назвается, но в этот массив мы добавим наши значения
    $values['value'] = json_encode($result, JSON_UNESCAPED_UNICODE); // записываем наши значения в массив возвращаемых значений
}

Кроме этого нам нужен плагин на событие msOnBeforeCreateOrder, в котором мы будем пересчитывать стоимость заказа перед его сохранением.

<?php
if($_POST['promocode']){ // если есть промокод
    $delivery_cost =  $msOrder->get('delivery_cost'); // получаем стомость доставки
    $old_cost =  $msOrder->get('cart_cost'); // получаем старую стомость заказа
    $result = $modx->runSnippet('validatePromocode', array('value' => $_POST['promocode'], 'changeCount' => true)); // проверяем валидность промокода
    if(!is_array($result)){ // если есть ошибки
        $modx->log(1, 'PLUGIN recalcOrderCost' . $result); // выводим их в лог и больше ничего не делаем
    }
    else{ // если ошибок нет
        $percent = (int)$result['percent']; // получаем процент скидки
        $new_cost = $old_cost - $old_cost * $percent / 100; // рассчитываем новую стоимость заказа
        $msOrder->set('old_cost', $old_cost); // сохраняем старую стоимость заказа для корректной работы  msOrderDiscount
        $msOrder->set('cost', $new_cost + $delivery_cost); // устанавливаем новую стоимость заказа
        $msOrder->set('cart_cost', $new_cost); // устанавливаем новую стоимость покупок
        $msOrder->set('discount_size', $percent.'%'); // записываем размер скидки (требуется установить компонент msOrderDiscount)        
         $msOrder->set('comment',  'Применён промокод ' . strip_tags($_POST['promocode'])); // устанавливаем comment с названием промокода в заказ
    }
}

Осталось немного дополнить стандартный JavaScript. Для этого копируем assets/components/minishop2/js/web/default.js, новый файл называем assets/components/minishop2/js/web/custom.js. Меняем системную настройку ms2_frontend_js на [[+jsUrl]]web/custom.js. Затем открываем custom.js на редактирование и добавляем следующий код

//ПРОМОКОДЫ
        
        // функция получения cookie
        function getCookie(name) {
            let matches = document.cookie.match(new RegExp(
                "(?:^|; )" + name.replace(/([\.$?*|{}\(\)\[\]\\\/\+^])/g, '\\$1') + "=([^;]*)"
            ));
            return matches ? decodeURIComponent(matches[1]) : undefined;
        }

        // функция очистки cookie от данных о промокоде
        function clearPromocodeCookie() {
            recalcOrderCost(getCookie('old_cost'), 0); // пересчитываем стоимость заказа
            document.querySelector('.jsDiscount').classList.add('d-none'); // скрываем блок с сообщением о скидке
            // очищаем куки
            document.cookie = 'discount=';
            document.cookie = 'old_cost=';
            document.cookie = 'promocode=';
            document.cookie = 'new_cost=';
        }

        // функция пересчёта стоимости заказа
        function recalcOrderCost(cost, percent) {
            let newCost = cost - cost * percent / 100, // рассчитываем стоимость со скидкой
                delivery_cost = 0; // стоимость доставки
            if(document.querySelector('.jsDeliveryCost')){
                delivery_cost = Number(document.querySelector('.jsDeliveryCost').innerText.replace('/\s+/', '')); // получаем стоимость доставки если есть
            }
            document.getElementById('ms2_order_cost').innerText = miniShop2.Utils.number_format(newCost + delivery_cost, 0, '.', ' '); // форматируем цену
            document.querySelector('.jsCost').innerText =  miniShop2.Utils.number_format(newCost, 0, '.', ' '); 
            // устанавливаем куки
            document.cookie = 'old_cost=' + cost;
            document.cookie = 'new_cost=' + newCost;
        }

        miniShop2.Callbacks.add('Order.add.response.success', 'orders_add_ok', function (response) {
            if (response.data.promocode) { // если промокод введён
                let promocode = JSON.parse(response.data.promocode), // получаем данные из ответа сервера
                    cost = Number(document.querySelector('.jsCost').dataset.cost), // получаем текущую стоимость заказа
                    percent = Number(promocode.percent); // получаем процент скидки
                
                document.querySelector('input[name="promocode"]').value = promocode.value; // прописываем промокод после проверки
                document.getElementById('discount').innerText = percent; // прописываем размер скидки по промокоду
 
                recalcOrderCost(cost, percent); // пересчитываем стоимость заказа

                document.cookie = 'discount=' + percent; // записываем % в куки
                document.cookie = 'promocode=' + promocode.value; // записываем промокод в куки
                document.querySelector('.jsDiscount').classList.remove('d-none'); // показываем блок с сообщением о скидке
            }
        });

        miniShop2.Callbacks.add('Order.getcost.response.success', 'order_getcost', function (response) {
            if (getCookie('promocode')) { // если промокод есть в куках
                let cost = Number(response.data.cart_cost), // получаем текущую стоимость заказа
                    delivery_cost = Number(response.data.delivery_cost), // получаем стоимость доставки
                    percent = Number(getCookie('discount')); // получаем процент скидки из куков
                recalcOrderCost(cost, percent); // пересчитываем стоимость заказа
            }
        });

        miniShop2.Callbacks.add('Order.submit.response.success', 'clear_cookie', function (response) {
            clearPromocodeCookie(); // очищаем куки
        });

        if (document.querySelector('input[name="promocode"]')) {
            document.querySelector('input[name="promocode"]').addEventListener('change', function (e) {
                if (!e.target.value) { // если промокод удалили
                    clearPromocodeCookie(); // пересчитываем стоимость заказа
                }
            });
        }
        
    });

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

<input type="text" placeholder="Промокод" name="promocode" value="{$.cookie.promocode}" class="input">

И блок для вывода информации о скидке

<h5 class="mb-md-0 text-red jsDiscount {!$.cookie.discount ? 'd-none': ''}">
    Скидка:  
    <span id="discount">{$.cookie.discount ?: 0}</span> 
    <small>%</small>
</h5>

Блок вывода стоимости заказа тоже немного изменим

{set $orderCost = $.cookie.new_cost ?: $order.cart_cost}          
        <h3>
            <span class="jsCost" id="ms2_order_cart_cost" data-cost="{$order.cart_cost | replace: ' ' : ''}">{$orderCost ?: 0}</span> {'ms2_frontend_currency' | lexicon} +
            <span class="jsDeliveryCost" id="ms2_order_delivery_cost">{$order.delivery_cost ?: 0}</span> {'ms2_frontend_currency' | lexicon} =
            <span id="ms2_order_cost">{$order.cost ?: 0}</span> {'ms2_frontend_currency' | lexicon}
        </h3>

Функционал конечно простой, скидка может быть указана только в процентах, но зато бесплатно.
На этом всё!