You are here

class PackageType in Commerce Shipping 8.2

Same name in this branch
  1. 8.2 src/Entity/PackageType.php \Drupal\commerce_shipping\Entity\PackageType
  2. 8.2 src/Plugin/Commerce/PackageType/PackageType.php \Drupal\commerce_shipping\Plugin\Commerce\PackageType\PackageType

Defines the class for package types.

Hierarchy

Expanded class hierarchy of PackageType

2 files declare their use of PackageType
PackageTypeManager.php in src/PackageTypeManager.php
PackageTypeTest.php in tests/src/Unit/Plugin/Commerce/PackageType/PackageTypeTest.php
1 string reference to 'PackageType'
commerce_shipping.commerce_package_types.yml in ./commerce_shipping.commerce_package_types.yml
commerce_shipping.commerce_package_types.yml

File

src/Plugin/Commerce/PackageType/PackageType.php, line 12

Namespace

Drupal\commerce_shipping\Plugin\Commerce\PackageType
View source
class PackageType extends PluginBase implements PackageTypeInterface {

  /**
   * The package type length.
   *
   * @var \Drupal\physical\Length
   */
  protected $length;

  /**
   * The package type width.
   *
   * @var \Drupal\physical\Length
   */
  protected $width;

  /**
   * The package type height.
   *
   * @var \Drupal\physical\Length
   */
  protected $height;

  /**
   * The package type weight.
   *
   * @var \Drupal\physical\Weight
   */
  protected $weight;

  /**
   * Constructs a new PackageType 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $dimensions = $plugin_definition['dimensions'];
    $this->length = new Length($dimensions['length'], $dimensions['unit']);
    $this->width = new Length($dimensions['width'], $dimensions['unit']);
    $this->height = new Length($dimensions['height'], $dimensions['unit']);
    $weight = $plugin_definition['weight'];
    $this->weight = new Weight($weight['number'], $weight['unit']);
  }

  /**
   * {@inheritdoc}
   */
  public function getId() {
    return $this->pluginDefinition['id'];
  }

  /**
   * {@inheritdoc}
   */
  public function getRemoteId() {
    return $this->pluginDefinition['remote_id'];
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel() {
    return $this->pluginDefinition['label'];
  }

  /**
   * {@inheritdoc}
   */
  public function getLength() {
    return $this->length;
  }

  /**
   * {@inheritdoc}
   */
  public function getWidth() {
    return $this->width;
  }

  /**
   * {@inheritdoc}
   */
  public function getHeight() {
    return $this->height;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this->weight;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
PackageType::$height protected property The package type height.
PackageType::$length protected property The package type length.
PackageType::$weight protected property The package type weight.
PackageType::$width protected property The package type width.
PackageType::getHeight public function Gets the package type height. Overrides PackageTypeInterface::getHeight
PackageType::getId public function Gets the package type ID. Overrides PackageTypeInterface::getId
PackageType::getLabel public function Gets the translated label. Overrides PackageTypeInterface::getLabel
PackageType::getLength public function Gets the package type length. Overrides PackageTypeInterface::getLength
PackageType::getRemoteId public function Gets the package type remote ID. Overrides PackageTypeInterface::getRemoteId
PackageType::getWeight public function Gets the package type weight. Overrides PackageTypeInterface::getWeight
PackageType::getWidth public function Gets the package type width. Overrides PackageTypeInterface::getWidth
PackageType::__construct public function Constructs a new PackageType object. Overrides PluginBase::__construct
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.
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.