Есть список районов города, доставка в которые имеет фиксированную ставку. Пользователь выбирает район — программа должна подставить цену доставки для этого района.
Задача вроде простая, но приходится решать много попутных вопросов и в комплексе получается довольно сложно.
Как основу будем использовать модуль Commerce Shipping. Он реализует пару схем расчёта доставки и нам потребуется написать собственный расчет, как плагин для этого модуля.
Районы (зоны доставки) я создал как таксономию, мне кажется это удобно для управления ценами и добавления новых районов — zony_dostavki.
В этом словаре нужно создать поле, куда можно будет вписывать цену за доставку в этот район — field_stoimost_dostavki. Это поле типа «Цена», которое предоставляется модулем Commerce.
Настройка Commerce Shipping
Чтобы Shipping начал работать для ваших заказов, нужно провести настройки как «типа заказа» так и «типа товара».
В нужных типах заказов (если вы используете несколько) проставьте галку «разрешить доставку для этого типа заказов»:
В товарах, а вернее в настройках вариации товара, нужно указать что — это «доставляемый» товар.
Я отдельно на этом останавливаюсь, т.к. иначе панель доставки, вставленная в процесс оформления заказа в нужный вам этап, просто не будет отображаться. И многие задают вопросы вроде — «А почему не показывается панель (pane) доставки?».
Создание плагинов
Теперь отвлечемся от настроек и займемся делом. Нам нужно создать пару плагинов:
- Панель с выводом поля, где пользователь выбирает район доставки для создаваемого заказа;
- Собственный механизм расчета доставки, на основе выбранного района.
Панель для процесса оформления заказа
Таксономия со списком районов у нас уже создана, нам нужно поле в заказе. Добавим поле в настройки типа заказа (field_rayon_dostavki):
Это ссылка на сущность, в данном случае таксономии «Зоны доставки».
Теперь создадим панельку для конструктора «процесса оформления», с выводом этого поля. В Drupal 8/9 это выполняется как плагин с соответствующей аннотацией. Итак, файл, описывающий еще одну CheckoutPane, размещают в папке <YOUR-MODULE>/src/Plugin/Commerce/CheckoutPane с именем соответствующим имени нового класса — ShowDistrictField.php:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
<?php namespace Drupal\<YOUR-MODULE-NAME>\Plugin\Commerce\CheckoutPane; use Drupal\commerce_checkout\Plugin\Commerce\CheckoutPane\CheckoutPaneBase; use Drupal\Core\Form\FormStateInterface; use Drupal\commerce_order\Entity\Order; /** * Provides a custom message pane. * * @CommerceCheckoutPane( * id = "checkout_pane_with_district_field", * label = @Translation("District Field"), * display_label = @Translation("Delivery District"), * wrapper_element = "fieldset", * default_step = "_disabled", * ) */ class ShowDistrictField extends CheckoutPaneBase { /** * {@inheritdoc} */ public function buildPaneForm(array $pane_form, FormStateInterface $form_state, array &$complete_form) { // грузим районы из таксономии $query = \Drupal::entityQuery('taxonomy_term'); $query->condition('vid', 'zony_dostavki'); $tids = $query->execute(); $terms = \Drupal\taxonomy\Entity\Term::loadMultiple($tids); $options = []; foreach($terms as $term) { $options[$term->get('tid')->value] = $term->get('name')->value; } // формируем поле, дефолт значение читаем из объекта заказа $pane_form['district'] = [ '#type' => 'select', '#title' => $this->t('Select your district'), '#options' => $options, '#default_value' => $this->order->field_rayon_dostavki->target_id, ]; return $pane_form; } public function submitPaneForm(array &$pane_form, FormStateInterface $form_state, array &$complete_form) { // сохраняем значение в заказе $values = $form_state->getValue($pane_form['#parents']); $this->order->set('field_rayon_dostavki', $values['district']); $this->order->save(); } } |
Свой механизм расчета доставки
Плагин для расчета доставки в терминах Drupal Commerce / Commerce Shipping обычно расширяет класс ShippingMethodBase, но мы будем использовать как основу класс FlatRate.
Создадим файл DistrictBased.php в папке <YOUR-MODULE>/src/Plugin/Commerce/ShippingMethod.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
<?php namespace Drupal\<YOUR-MODULE-NAME>\Plugin\Commerce\ShippingMethod; use Drupal\commerce_shipping\Plugin\Commerce\ShippingMethod\FlatRate; use Drupal\commerce_price\Price; use Drupal\commerce_shipping\Entity\ShipmentInterface; use Drupal\commerce_shipping\ShippingRate; use Drupal\Core\Form\FormStateInterface; use Drupal\commerce_order\Entity\Order; /** * Provides the DistrictBased shipping method. * * @CommerceShippingMethod( * id = "district_based", * label = @Translation("District based"), * ) */ class DistrictBased extends FlatRate { /** * {@inheritdoc} */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { // т.к. назначение поля базового класса поменялось, // то я перепишу описание для этого поля $form = parent::buildConfigurationForm($form, $form_state); $form['rate_amount']['#description'] = t('Default rate if price is not defined in taxonomy zony_dostavki.'); return $form; } /** * {@inheritdoc} */ public function calculateRates(ShipmentInterface $shipment) { // я использую цену из настроек метода как цену по умолчанию // но задача - прочитать код выбранного района и // загрузить цену из таксономии $amount = Price::fromArray($this->configuration['rate_amount']); $order_id = $shipment->get('order_id')->target_id; if ($order_id) { $order = Order::load($order_id); $district_id = $order->get('field_rayon_dostavki')->target_id; if ($district_id) { $term = \Drupal::entityTypeManager()->getStorage('taxonomy_term')->load($district_id); $priceFromTaxonomy = $term->get('field_stoimost_dostavki'); if ($priceFromTaxonomy->number > 0) { $amount = Price::fromArray(['number'=> $priceFromTaxonomy->number, 'currency_code' => $priceFromTaxonomy->currency_code]); } } } // здесь мы формируем опции доставки $rates = []; $rates[] = new ShippingRate([ 'shipping_method_id' => $this->parentEntity->id(), 'service' => $this->services['default'], 'amount' => $amount, ]); return $rates; } } |
Как видите, опять же не сложный кусочек кода, но здесь множество вещей, которые нужно знать как делать.
Сбросьте кеш, чтобы Drupal прочитал новые плагины.
Настройка способов доставки
Мы создали метод расчета доставки, но в CMS, используя этот метод, нужно настроить «способ доставки».
Включим наш плагин расчета (District based) и заполним остальные поля. Цена, указанная здесь, будет ценой по умолчанию, если район не выбран.
Настройка панелей (panes) процесса оформления
Теперь всё готово, к тому чтобы расставить панели в нужном порядке.
Т.к. данные о районе попадают в объект заказа при сохранении данных очередного шага оформления, то нам нужно разнести панельку с полем выбора района и расчетом (+ данными и прочим) доставки на разные шаги. У меня это выглядело вот так:
