class OrderStore in Commerce Core 8.2
Provides the store condition for orders.
Plugin annotation
@CommerceCondition(
id = "order_store",
label = @Translation("Store", context = "Commerce"),
display_label = @Translation("Store", context = "Commerce"),
category = @Translation("Order", context = "Commerce"),
entity_type = "commerce_order",
)
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_order\Plugin\Commerce\Condition\OrderStore implements ContainerFactoryPluginInterface
- class \Drupal\commerce\Plugin\Commerce\Condition\ConditionBase implements ConditionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of OrderStore
1 file declares its use of OrderStore
- OrderStoreTest.php in modules/
order/ tests/ src/ Unit/ Plugin/ Commerce/ Condition/ OrderStoreTest.php
File
- modules/
order/ src/ Plugin/ Commerce/ Condition/ OrderStore.php, line 23
Namespace
Drupal\commerce_order\Plugin\Commerce\ConditionView source
class OrderStore extends ConditionBase implements ContainerFactoryPluginInterface {
/**
* The entity UUID mapper.
*
* @var \Drupal\commerce\EntityUuidMapperInterface
*/
protected $entityUuidMapper;
/**
* Constructs a new OrderStore 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\commerce\EntityUuidMapperInterface $entity_uuid_mapper
* The entity UUID mapper.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityUuidMapperInterface $entity_uuid_mapper) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->entityUuidMapper = $entity_uuid_mapper;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('commerce.entity_uuid_mapper'));
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
// The store UUIDs.
'stores' => [],
] + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
// Map the UUIDs back to IDs for the form element.
$store_ids = $this->entityUuidMapper
->mapToIds('commerce_store', $this->configuration['stores']);
$form['stores'] = [
'#type' => 'commerce_entity_select',
'#title' => $this
->t('Stores'),
'#default_value' => $store_ids,
'#target_type' => 'commerce_store',
'#hide_single_entity' => FALSE,
'#multiple' => TRUE,
'#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['stores'] = $this->entityUuidMapper
->mapFromIds('commerce_store', $values['stores']);
}
/**
* {@inheritdoc}
*/
public function evaluate(EntityInterface $entity) {
$this
->assertEntity($entity);
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $entity;
return in_array($order
->getStore()
->uuid(), $this->configuration['stores']);
}
}
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:: |
|
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. | |
OrderStore:: |
protected | property | The entity UUID mapper. | |
OrderStore:: |
public | function |
Form constructor. Overrides ConditionBase:: |
|
OrderStore:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
OrderStore:: |
public | function |
Gets default configuration for this plugin. Overrides ConditionBase:: |
|
OrderStore:: |
public | function |
Evaluates the condition. Overrides ConditionInterface:: |
|
OrderStore:: |
public | function |
Form submission handler. Overrides ConditionBase:: |
|
OrderStore:: |
public | function |
Constructs a new OrderStore object. Overrides ConditionBase:: |
|
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. |