You are here

Home » API reference » Commerce Shipping 8.2 » ShipmentWeight.php

class ShipmentWeight in Commerce Shipping 8.2

Provides the weight condition for shipments.

Plugin annotation


@CommerceCondition(
  id = "shipment_weight",
  label = @Translation("Shipment weight"),
  category = @Translation("Shipment"),
  entity_type = "commerce_shipment",
)

Hierarchy

Expanded class hierarchy of ShipmentWeight

1 file declares its use of ShipmentWeight
ShipmentWeightTest.php in tests/src/Unit/Plugin/Commerce/Condition/ShipmentWeightTest.php

File

src/Plugin/Commerce/Condition/ShipmentWeight.php, line 21

Namespace

Drupal\commerce_shipping\Plugin\Commerce\Condition
View source 
class ShipmentWeight extends ConditionBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'operator' => '>',
      'weight' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $weight = $this->configuration['weight'];
    $form['operator'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Operator'),
      '#options' => $this
        ->getComparisonOperators(),
      '#default_value' => $this->configuration['operator'],
      '#required' => TRUE,
    ];
    $form['weight'] = [
      '#type' => 'physical_measurement',
      '#measurement_type' => MeasurementType::WEIGHT,
      '#title' => $this
        ->t('Weight'),
      '#default_value' => $weight,
      '#required' => TRUE,
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  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;
    }
    $condition_unit = $this->configuration['weight']['unit'];

    /** @var \Drupal\physical\Weight $weight */
    $weight = $weight
      ->convert($condition_unit);
    $condition_weight = new Weight($this->configuration['weight']['number'], $condition_unit);
    switch ($this->configuration['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']}");
    }
  }

}

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
ConditionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 8
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.
ShipmentWeight::buildConfigurationForm public function Form constructor. Overrides ConditionBase::buildConfigurationForm
ShipmentWeight::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConditionBase::defaultConfiguration
ShipmentWeight::evaluate public function Evaluates the condition. Overrides ConditionInterface::evaluate
ShipmentWeight::submitConfigurationForm public function Form submission handler. Overrides ConditionBase::submitConfigurationForm
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.