class ShipmentAddress in Commerce Shipping 8.2
Provides the shipping address condition for shipments.
Plugin annotation
@CommerceCondition(
id = "shipment_address",
label = @Translation("Shipping address"),
category = @Translation("Customer"),
entity_type = "commerce_shipment",
weight = 10,
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\commerce\Plugin\Commerce\Condition\ConditionBase implements ConditionInterface
- class \Drupal\commerce_shipping\Plugin\Commerce\Condition\ShipmentAddress
- class \Drupal\commerce\Plugin\Commerce\Condition\ConditionBase implements ConditionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ShipmentAddress
1 file declares its use of ShipmentAddress
- ShipmentAddressTest.php in tests/
src/ Unit/ Plugin/ Commerce/ Condition/ ShipmentAddressTest.php
File
- src/
Plugin/ Commerce/ Condition/ ShipmentAddress.php, line 21
Namespace
Drupal\commerce_shipping\Plugin\Commerce\ConditionView source
class ShipmentAddress extends ConditionBase {
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'zone' => NULL,
'negate' => NULL,
] + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$form['zone'] = [
'#type' => 'address_zone',
'#default_value' => $this->configuration['zone'],
'#required' => TRUE,
];
$form['negate'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Negate'),
'#description' => $this
->t('If checked, the value(s) selected should not match.'),
'#default_value' => $this->configuration['negate'],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
parent::submitConfigurationForm($form, $form_state);
$values = $form_state
->getValue($form['#parents']);
// Work around an Address bug where the Remove button value is kept in the
// array.
foreach ($values['zone']['territories'] as &$territory) {
unset($territory['remove']);
}
// Don't store the label, it's always hidden and empty.
unset($values['zone']['label']);
$this->configuration['zone'] = $values['zone'];
$this->configuration['negate'] = $values['negate'];
}
/**
* {@inheritdoc}
*/
public function evaluate(EntityInterface $entity) {
$this
->assertEntity($entity);
/** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
$shipment = $entity;
$shipping_profile = $shipment
->getShippingProfile();
if (!$shipping_profile) {
return FALSE;
}
$address = $shipping_profile
->get('address')
->first();
if (!$address) {
// The conditions can't be applied until the shipping address is known.
return FALSE;
}
$zone = new Zone([
'id' => 'shipping',
'label' => 'N/A',
] + $this->configuration['zone']);
if ($this->configuration['negate']) {
return !$zone
->match($address);
}
return $zone
->match($address);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ConditionBase:: |
protected | function | Asserts that the given entity is of the expected type. | |
ConditionBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
ConditionBase:: |
protected | function | Gets the comparison operators. | |
ConditionBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
ConditionBase:: |
public | function |
Gets the condition display label. Overrides ConditionInterface:: |
|
ConditionBase:: |
public | function |
Gets the condition entity type ID. Overrides ConditionInterface:: |
|
ConditionBase:: |
public | function |
Gets the condition label. Overrides ConditionInterface:: |
|
ConditionBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
ConditionBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
ConditionBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
8 |
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. | |
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. | |
ShipmentAddress:: |
public | function |
Form constructor. Overrides ConditionBase:: |
|
ShipmentAddress:: |
public | function |
Gets default configuration for this plugin. Overrides ConditionBase:: |
|
ShipmentAddress:: |
public | function |
Evaluates the condition. Overrides ConditionInterface:: |
|
ShipmentAddress:: |
public | function |
Form submission handler. Overrides ConditionBase:: |
|
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. |