ShippingByWeight.php in Commerce Shipping Weight Tariff 8.2

Namespace

Drupal\commerce_shipping_weight_tariff\Plugin\Commerce\ShippingMethod

File

src/Plugin/Commerce/ShippingMethod/ShippingByWeight.php

<?php

namespace Drupal\commerce_shipping_weight_tariff\Plugin\Commerce\ShippingMethod;

use Drupal\commerce_price\Price;
use Drupal\commerce_shipping\Entity\ShipmentInterface;
use Drupal\commerce_shipping\PackageTypeManagerInterface;
use Drupal\commerce_shipping\Plugin\Commerce\ShippingMethod\ShippingMethodBase;
use Drupal\commerce_shipping\ShippingRate;
use Drupal\commerce_shipping\ShippingService;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\State\StateInterface;
use Drupal\state_machine\WorkflowManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides the FlatRatePerItem shipping method.
 *
 * @CommerceShippingMethod(
 *   id = "commerce_shipping_weight_tariff",
 *   label = @Translation("Shipping by weight tariff"),
 * )
 */
class ShippingByWeight extends ShippingMethodBase {
  protected $stateService;

  /**
   * Constructs a new ShippingByWeight object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\commerce_shipping\PackageTypeManagerInterface $package_type_manager
   *   The package type manager.
   * @param \Drupal\Core\State\StateInterface $stateService
   *   The Drupal State Service.
   * @param \Drupal\state_machine\WorkflowManagerInterface $workflow_manager
   *   The workflow manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PackageTypeManagerInterface $package_type_manager, WorkflowManagerInterface $workflow_manager, StateInterface $stateService) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $package_type_manager, $workflow_manager);
    $this->services['default'] = new ShippingService('default', $this->configuration['rate_label']);
    $this->stateService = $stateService;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.commerce_package_type'), $container
      ->get('plugin.manager.workflow'), $container
      ->get('state'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'rate_label' => '',
      'base_rate_amount' => '',
      'services' => [
        'default',
      ],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $amount = $this->configuration['base_rate_amount'];

    // A bug in the plugin_select form element causes $amount to be incomplete.
    if (isset($amount) && !isset($amount['number'], $amount['currency_code'])) {
      $amount = NULL;
    }
    $form['rate_label'] = [
      '#type' => 'textfield',
      '#title' => t('Shipment type label'),
      '#description' => t('Shown to customers during checkout.'),
      '#default_value' => $this->configuration['rate_label'],
      '#required' => TRUE,
    ];
    $form['base_rate_amount'] = [
      '#type' => 'commerce_price',
      '#title' => t('Base shipping rate amount'),
      '#default_value' => $amount,
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    if (!$form_state
      ->getErrors()) {
      $values = $form_state
        ->getValue($form['#parents']);
      $this->configuration['rate_label'] = $values['rate_label'];
      $this->configuration['base_rate_amount'] = $values['base_rate_amount'];
    }
  }

  /**
   * Calculates shipment rate depending on weight conditions.
   *
   * @param \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment
   *   Shipment interface entity.
   *
   * @return array
   *   Returns calculated rates.
   */
  public function calculateRates(ShipmentInterface $shipment) {

    // Rate IDs aren't used in a flat rate scenario because there's always a
    // single rate per plugin, and there's no support for purchasing rates.
    $amount = $this->configuration['base_rate_amount'];
    $shipment_tax_by_weight = $this->stateService
      ->get('order_' . $shipment
      ->getOrderId() . '_weight_condition');
    $this->stateService
      ->delete('order_' . $shipment
      ->getOrderId() . '_weight_condition');

    // Calculate shipping amount.
    $shipping_tax_value = $shipment_tax_by_weight['condition_price'] + $amount['number'];

    // Set shipping amount.
    $amount = new Price((string) $shipping_tax_value, $amount['currency_code']);
    $rates = [];

    // Set shipping rate.
    $rates[] = new ShippingRate([
      'shipping_method_id' => $this->parentEntity
        ->id(),
      'service' => $this->services['default'],
      'amount' => $amount,
    ]);
    return $rates;
  }

}

Classes

Name	Description
ShippingByWeight	Provides the FlatRatePerItem shipping method.