class PackageType in Commerce Shipping 8.2
Same name in this branch
- 8.2 src/Entity/PackageType.php \Drupal\commerce_shipping\Entity\PackageType
- 8.2 src/Plugin/Commerce/PackageType/PackageType.php \Drupal\commerce_shipping\Plugin\Commerce\PackageType\PackageType
Defines the class for package types.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\commerce_shipping\Plugin\Commerce\PackageType\PackageType implements PackageTypeInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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'
File
- src/
Plugin/ Commerce/ PackageType/ PackageType.php, line 12
Namespace
Drupal\commerce_shipping\Plugin\Commerce\PackageTypeView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PackageType:: |
protected | property | The package type height. | |
PackageType:: |
protected | property | The package type length. | |
PackageType:: |
protected | property | The package type weight. | |
PackageType:: |
protected | property | The package type width. | |
PackageType:: |
public | function |
Gets the package type height. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the package type ID. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the translated label. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the package type length. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the package type remote ID. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the package type weight. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Gets the package type width. Overrides PackageTypeInterface:: |
|
PackageType:: |
public | function |
Constructs a new PackageType object. Overrides PluginBase:: |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |