You are here

Home » API reference » Commerce Shipping Weight Tariff 8.2 » ShipmentWeightMultipleConds.php

class ShipmentWeightMultipleConds in Commerce Shipping Weight Tariff 8.2

Same name and namespace in other branches
  1. 8 src/Plugin/Commerce/Condition/ShipmentWeightMultipleConds.php \Drupal\commerce_shipping_weight_tariff\Plugin\Commerce\Condition\ShipmentWeightMultipleConds

Provides the multiple weight condition for shipments.

Plugin annotation


@CommerceCondition(
  id = "shipment_weight_multiple_conds",
  label = @Translation("Shipment weight - Multiple Conditions"),
  category = @Translation("Shipment"),
  entity_type = "commerce_shipment",
)

Hierarchy

Expanded class hierarchy of ShipmentWeightMultipleConds

File

src/Plugin/Commerce/Condition/ShipmentWeightMultipleConds.php, line 24

Namespace

Drupal\commerce_shipping_weight_tariff\Plugin\Commerce\Condition
View source 
class ShipmentWeightMultipleConds extends ConditionBase implements ContainerFactoryPluginInterface {
  protected $stateService;

  /**
   * Constructs a new ShipmentWeightMultipleConds object.
   *
   * @param array $configuration
   *   The plugin configuration, i.e. an array with configuration values keyed
   *   by configuration option name.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\State\StateInterface $stateService
   *   The Drupal State Service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, StateInterface $stateService) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $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('state'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'condition_1' => [
        'price' => NULL,
        'operator' => '<',
        'weight' => NULL,
        'enabled' => TRUE,
      ],
      'condition_2' => [
        'price' => NULL,
        'operator' => '<',
        'weight' => NULL,
        'enabled' => TRUE,
      ],
      'condition_3' => [
        'price' => NULL,
        'operator' => '<',
        'weight' => NULL,
        'enabled' => TRUE,
      ],
      'condition_4' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => TRUE,
      ],
      'condition_5' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
      'condition_6' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
      'condition_7' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
      'condition_8' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
      'condition_9' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
      'condition_10' => [
        'price' => NULL,
        'operator' => '>',
        'weight' => NULL,
        'enabled' => FALSE,
      ],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);

    // Preparing condition fieldsets.
    for ($i = 1; $i <= 10; $i++) {
      $weight = $this->configuration['condition_' . $i]['weight'];
      $price = $this->configuration['condition_' . $i]['price'];
      $enabled = $this->configuration['condition_' . $i]['enabled'];
      $operator = $this->configuration['condition_' . $i]['operator'];
      $form['condition_' . $i] = [
        '#type' => 'fieldset',
        '#title' => 'Condition group #' . $i,
      ];
      $form['condition_' . $i]['enabled'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Enabled?'),
        '#default_value' => $enabled,
      ];

      // Check 'Enabled' checkbox if condition group should be enabled.
      if ($enabled) {
        $form['condition_' . $i]['enabled']['#attributes'] = [
          'checked' => 'checked',
        ];
      }

      // Show condition group fields only when 'Enabled' checkbox is checked.
      $form['condition_' . $i]['price'] = [
        '#type' => 'commerce_price',
        '#title' => t('Price'),
        '#default_value' => $price,
        '#required' => FALSE,
        '#states' => [
          'invisible' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => FALSE,
            ],
          ],
          'required' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['condition_' . $i]['operator'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Operator'),
        '#options' => $this
          ->getComparisonOperators(),
        '#default_value' => $operator,
        '#required' => FALSE,
        '#states' => [
          'invisible' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => FALSE,
            ],
          ],
          'required' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
      $form['condition_' . $i]['weight'] = [
        '#type' => 'physical_measurement',
        '#measurement_type' => MeasurementType::WEIGHT,
        '#title' => $this
          ->t('Weight'),
        '#default_value' => $weight,
        '#required' => FALSE,
        '#states' => [
          'invisible' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => FALSE,
            ],
          ],
          'required' => [
            ':input[name="conditions[form][shipment][shipment_weight_multiple_conds][configuration][form][condition_' . $i . '][enabled]"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);

    // Saving configuration values.
    $values = $form_state
      ->getValue($form['#parents']);
    for ($i = 1; $i <= 10; $i++) {
      $this->configuration['condition_' . $i]['enabled'] = $values['condition_' . $i]['enabled'];
      $this->configuration['condition_' . $i]['price'] = $values['condition_' . $i]['price'];
      $this->configuration['condition_' . $i]['operator'] = $values['condition_' . $i]['operator'];
      $this->configuration['condition_' . $i]['weight'] = $values['condition_' . $i]['weight'];
    }
  }

  /**
   * Validates filling of price and weight fields in enabled fieldsets.
   *
   * @param array $form
   *   Configuration form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state object.
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $values = $form_state
      ->getValue($form['#parents']);
    for ($i = 1; $i <= 10; $i++) {
      $enabled = $values['condition_' . $i]['enabled'];
      $price = $values['condition_' . $i]['price'];
      $weight = $values['condition_' . $i]['weight'];
      if (empty($price['number']) && !empty($enabled)) {
        $element = $form['condition_' . $i]['price'];
        $form_state
          ->setError($element, 'You must enter correct price value!');
      }
      if (empty($weight['number']) && !empty($enabled)) {
        $element = $form['condition_' . $i]['weight'];
        $form_state
          ->setError($element, 'You must enter correct weight value!');
      }
    }
  }

  /**
   * Evaluates shipment weight conditions.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Shipment entity object.
   *
   * @return bool
   *   Returns entity evaluation result.
   */
  public function evaluate(EntityInterface $entity) {
    $this
      ->assertEntity($entity);

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = $entity;
    $weight = $shipment
      ->getWeight();
    if (!$weight) {

      // The conditions can't be applied until the weight is known.
      return FALSE;
    }

    // Get enabled conditions list.
    $enabled_conditions = [];
    foreach ($this
      ->getConfiguration() as $config) {
      if (!empty($config['enabled'])) {
        $enabled_conditions[] = $config;
      }
    }

    // Evaluate matching conditions.
    if (count($enabled_conditions) === 1) {
      $condition_unit = $enabled_conditions['0']['weight']['unit'];

      /** @var \Drupal\physical\Weight $weight */
      $weight = $weight
        ->convert($condition_unit);
      $condition_weight = new Weight($enabled_conditions['0']['weight']['number'], $condition_unit);

      // Saving condition info to states.
      $this->stateService
        ->set('order_' . $shipment
        ->getOrderId() . '_weight_condition', $enabled_conditions['0']);

      // Return evaluation results.
      switch ($enabled_conditions['0']['operator']) {
        case '>=':
          return $weight
            ->greaterThanOrEqual($condition_weight);
        case '>':
          return $weight
            ->greaterThan($condition_weight);
        case '<=':
          return $weight
            ->lessThanOrEqual($condition_weight);
        case '<':
          return $weight
            ->lessThan($condition_weight);
        case '==':
          return $weight
            ->equals($condition_weight);
        default:
          throw new \InvalidArgumentException("Invalid operator {$this->configuration['operator']}");
      }
    }
    else {

      // Get matched conditions.
      $matched_conditions = [];
      foreach ($enabled_conditions as $key => $condition) {
        $condition_unit = $condition['weight']['unit'];

        /** @var \Drupal\physical\Weight $weight */
        $weight = $weight
          ->convert($condition_unit);
        $condition_weight = new Weight($condition['weight']['number'], $condition_unit);
        switch ($condition['operator']) {
          case '>=':
            $matched_conditions[$key]['condition_type'] = 'greaterThanOrEqual';
            $matched_conditions[$key]['condition_result'] = $weight
              ->greaterThanOrEqual($condition_weight);
            $matched_conditions[$key]['condition_weight'] = $condition['weight']['number'];
            $matched_conditions[$key]['condition_price'] = $condition['price']['number'];
            $matched_conditions[$key]['condition_operator'] = $condition['operator'];
            break;
          case '>':
            $matched_conditions[$key]['condition_type'] = 'greaterThan';
            $matched_conditions[$key]['condition_result'] = $weight
              ->greaterThan($condition_weight);
            $matched_conditions[$key]['condition_weight'] = $condition['weight']['number'];
            $matched_conditions[$key]['condition_price'] = $condition['price']['number'];
            $matched_conditions[$key]['condition_operator'] = $condition['operator'];
            break;
          case '<=':
            $matched_conditions[$key]['condition_type'] = 'lessThanOrEqual';
            $matched_conditions[$key]['condition_result'] = $weight
              ->lessThanOrEqual($condition_weight);
            $matched_conditions[$key]['condition_weight'] = $condition['weight']['number'];
            $matched_conditions[$key]['condition_price'] = $condition['price']['number'];
            $matched_conditions[$key]['condition_operator'] = $condition['operator'];
            break;
          case '<':
            $matched_conditions[$key]['condition_type'] = 'lessThan';
            $matched_conditions[$key]['condition_result'] = $weight
              ->lessThan($condition_weight);
            $matched_conditions[$key]['condition_weight'] = $condition['weight']['number'];
            $matched_conditions[$key]['condition_price'] = $condition['price']['number'];
            $matched_conditions[$key]['condition_operator'] = $condition['operator'];
            break;
          case '==':
            $matched_conditions[$key]['condition_type'] = 'equals';
            $matched_conditions[$key]['condition_result'] = $weight
              ->equals($condition_weight);
            $matched_conditions[$key]['condition_weight'] = $condition['weight']['number'];
            $matched_conditions[$key]['condition_price'] = $condition['price']['number'];
            $matched_conditions[$key]['condition_operator'] = $condition['operator'];
            break;
          default:
            throw new \InvalidArgumentException("Invalid operator {$this->configuration['operator']}");
        }
      }
      foreach ($matched_conditions as $match) {
        if ($match['condition_result'] === TRUE) {

          // Saving condition info to states.
          $this->stateService
            ->set('order_' . $shipment
            ->getOrderId() . '_weight_condition', $match);

          // Return evaluation results.
          return $weight
            ->{$match['condition_type']}($condition_weight);
        }
      }
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionBase::assertEntity protected function Asserts that the given entity is of the expected type.
ConditionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionBase::getComparisonOperators protected function Gets the comparison operators.
ConditionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionBase::getDisplayLabel public function Gets the condition display label. Overrides ConditionInterface::getDisplayLabel
ConditionBase::getEntityTypeId public function Gets the condition entity type ID. Overrides ConditionInterface::getEntityTypeId
ConditionBase::getLabel public function Gets the condition label. Overrides ConditionInterface::getLabel
ConditionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ShipmentWeightMultipleConds::$stateService protected property
ShipmentWeightMultipleConds::buildConfigurationForm public function Form constructor. Overrides ConditionBase::buildConfigurationForm
ShipmentWeightMultipleConds::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ShipmentWeightMultipleConds::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionBase::defaultConfiguration
ShipmentWeightMultipleConds::evaluate public function Evaluates shipment weight conditions. Overrides ConditionInterface::evaluate
ShipmentWeightMultipleConds::submitConfigurationForm public function Form submission handler. Overrides ConditionBase::submitConfigurationForm
ShipmentWeightMultipleConds::validateConfigurationForm public function Validates filling of price and weight fields in enabled fieldsets. Overrides ConditionBase::validateConfigurationForm
ShipmentWeightMultipleConds::__construct public function Constructs a new ShipmentWeightMultipleConds object. Overrides ConditionBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.