class OrderItemProduct in Commerce Core 8.2

Provides the product condition for order items.

Plugin annotation


@CommerceCondition(
  id = "order_item_product",
  label = @Translation("Product"),
  display_label = @Translation("Specific products"),
  category = @Translation("Products"),
  entity_type = "commerce_order_item",
  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\OrderItemProduct implements PurchasableEntityConditionInterface, ContainerFactoryPluginInterface uses ProductTrait

Expanded class hierarchy of OrderItemProduct

1 file declares its use of OrderItemProduct

OrderItemProductTest.php in modules/product/tests/src/Unit/Plugin/Commerce/Condition/OrderItemProductTest.php

File

modules/product/src/Plugin/Commerce/Condition/OrderItemProduct.php, line 25

Namespace

Drupal\commerce_product\Plugin\Commerce\Condition

View source

class OrderItemProduct extends ConditionBase implements PurchasableEntityConditionInterface, ContainerFactoryPluginInterface {
  use ProductTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new OrderItemProduct 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->entityTypeManager = $entity_type_manager;
    $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\OrderItemInterface $order_item */
    $order_item = $entity;

    /** @var \Drupal\commerce_product\Entity\ProductVariationInterface $purchased_entity */
    $purchased_entity = $order_item
      ->getPurchasedEntity();
    if (!$purchased_entity || $purchased_entity
      ->getEntityTypeId() != 'commerce_product_variation') {
      return FALSE;
    }
    $product_ids = $this
      ->getProductIds();
    return in_array($purchased_entity
      ->getProductId(), $product_ids);
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchasableEntityIds() {
    $variation_ids = [];
    $product_ids = $this
      ->getProductIds();
    if (!empty($product_ids)) {
      foreach ($this->productStorage
        ->loadMultiple($product_ids) as $product) {

        /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
        $variation_ids += $product
          ->getVariationIds();
      }
    }
    return array_values($variation_ids);
  }

  /**
   * {@inheritdoc}
   */
  public function getPurchasableEntities() {
    if ($entity_ids = $this
      ->getPurchasableEntityIds()) {
      $storage = $this->entityTypeManager
        ->getStorage('commerce_product_variation');
      $entities = $storage
        ->loadMultiple($entity_ids);
    }
    return $entities ?? [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionBase::assertEntity	protected	function	Asserts that the given entity is of the expected type.
ConditionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionBase::getComparisonOperators	protected	function	Gets the comparison operators.
ConditionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionBase::getDisplayLabel	public	function	Gets the condition display label. Overrides ConditionInterface::getDisplayLabel
ConditionBase::getEntityTypeId	public	function	Gets the condition entity type ID. Overrides ConditionInterface::getEntityTypeId
ConditionBase::getLabel	public	function	Gets the condition label. Overrides ConditionInterface::getLabel
ConditionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.
OrderItemProduct::$entityTypeManager	protected	property	The entity type manager.
OrderItemProduct::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
OrderItemProduct::evaluate	public	function	Evaluates the condition. Overrides ConditionInterface::evaluate
OrderItemProduct::getPurchasableEntities	public	function	Gets the configured purchasable entities. Overrides PurchasableEntityConditionInterface::getPurchasableEntities
OrderItemProduct::getPurchasableEntityIds	public	function	Gets the configured purchasable entity IDS. Overrides PurchasableEntityConditionInterface::getPurchasableEntityIds
OrderItemProduct::__construct	public	function	Constructs a new OrderItemProduct object. Overrides ConditionBase::__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.
ProductTrait::$entityUuidMapper	protected	property	The entity UUID mapper.
ProductTrait::$productStorage	protected	property	The product storage.
ProductTrait::buildConfigurationForm	public	function
ProductTrait::defaultConfiguration	public	function
ProductTrait::getProductIds	protected	function	Gets the configured product IDs.
ProductTrait::submitConfigurationForm	public	function
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.

You are here

class OrderItemProduct in Commerce Core 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation