class OrderProduct in Commerce Core 8.2
Provides the product condition for orders.
Plugin annotation
@CommerceCondition(
id = "order_product",
label = @Translation("Product"),
display_label = @Translation("Order contains specific products"),
category = @Translation("Products"),
entity_type = "commerce_order",
weight = -1,
)
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_product\Plugin\Commerce\Condition\OrderProduct implements ContainerFactoryPluginInterface uses ProductTrait
- class \Drupal\commerce\Plugin\Commerce\Condition\ConditionBase implements ConditionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of OrderProduct
1 file declares its use of OrderProduct
- OrderProductTest.php in modules/
product/ tests/ src/ Unit/ Plugin/ Commerce/ Condition/ OrderProductTest.php
File
- modules/
product/ src/ Plugin/ Commerce/ Condition/ OrderProduct.php, line 24
Namespace
Drupal\commerce_product\Plugin\Commerce\ConditionView source
class OrderProduct extends ConditionBase implements ContainerFactoryPluginInterface {
use ProductTrait;
/**
* Constructs a new OrderProduct 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\Core\Entity\EntityTypeManagerInterface $entity_type_manager
* The entity type manager.
* @param \Drupal\commerce\EntityUuidMapperInterface $entity_uuid_mapper
* The entity UUID mapper.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityUuidMapperInterface $entity_uuid_mapper) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->productStorage = $entity_type_manager
->getStorage('commerce_product');
$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('entity_type.manager'), $container
->get('commerce.entity_uuid_mapper'));
}
/**
* {@inheritdoc}
*/
public function evaluate(EntityInterface $entity) {
$this
->assertEntity($entity);
/** @var \Drupal\commerce_order\Entity\OrderInterface $order */
$order = $entity;
$product_ids = $this
->getProductIds();
foreach ($order
->getItems() as $order_item) {
/** @var \Drupal\commerce_product\Entity\ProductVariationInterface $purchased_entity */
$purchased_entity = $order_item
->getPurchasedEntity();
if (!$purchased_entity || $purchased_entity
->getEntityTypeId() != 'commerce_product_variation') {
continue;
}
if (in_array($purchased_entity
->getProductId(), $product_ids)) {
return TRUE;
}
}
return FALSE;
}
}
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. | |
OrderProduct:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
OrderProduct:: |
public | function |
Evaluates the condition. Overrides ConditionInterface:: |
|
OrderProduct:: |
public | function |
Constructs a new OrderProduct 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. | |
ProductTrait:: |
protected | property | The entity UUID mapper. | |
ProductTrait:: |
protected | property | The product storage. | |
ProductTrait:: |
public | function | ||
ProductTrait:: |
public | function | ||
ProductTrait:: |
protected | function | Gets the configured product IDs. | |
ProductTrait:: |
public | function | ||
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. |