You are here

Home » API reference » Commerce Core 8.2 » OrderItemProductCategory.php

class OrderItemProductCategory in Commerce Core 8.2

Provides the product category condition for order items.

Plugin annotation


@CommerceCondition(
  id = "order_item_product_category",
  label = @Translation("Product category"),
  display_label = @Translation("Product categories"),
  category = @Translation("Products"),
  entity_type = "commerce_order_item",
)

Hierarchy

Expanded class hierarchy of OrderItemProductCategory

1 file declares its use of OrderItemProductCategory
OrderItemProductCategoryTest.php in modules/product/tests/src/Unit/Plugin/Commerce/Condition/OrderItemProductCategoryTest.php

File

modules/product/src/Plugin/Commerce/Condition/OrderItemProductCategory.php, line 24

Namespace

Drupal\commerce_product\Plugin\Commerce\Condition
View source 
class OrderItemProductCategory extends ConditionBase implements ContainerFactoryPluginInterface {
  use ProductCategoryTrait;

  /**
   * Constructs a new OrderItemProductCategory 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\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @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, EntityFieldManagerInterface $entity_field_manager, EntityTypeManagerInterface $entity_type_manager, EntityUuidMapperInterface $entity_uuid_mapper) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityFieldManager = $entity_field_manager;
    $this->entityTypeManager = $entity_type_manager;
    $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_field.manager'), $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;
    }
    $term_ids = $this
      ->getTermIds();
    $referenced_ids = $this
      ->getReferencedIds($purchased_entity
      ->getProduct());
    return (bool) array_intersect($term_ids, $referenced_ids);
  }

}

Members

Namesort descending 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.
OrderItemProductCategory::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
OrderItemProductCategory::evaluate public function Evaluates the condition. Overrides ConditionInterface::evaluate
OrderItemProductCategory::__construct public function Constructs a new OrderItemProductCategory 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.
ProductCategoryTrait::$entityFieldManager protected property The entity field manager.
ProductCategoryTrait::$entityTypeManager protected property The entity type manager.
ProductCategoryTrait::$entityUuidMapper protected property The entity UUID mapper.
ProductCategoryTrait::buildConfigurationForm public function
ProductCategoryTrait::defaultConfiguration public function
ProductCategoryTrait::getEntityReferenceFieldMap protected function Gets the field map for product entity reference fields.
ProductCategoryTrait::getReferencedIds protected function Gets all referenced entity IDs for the given product.
ProductCategoryTrait::getTermIds protected function Gets the configured term IDs.
ProductCategoryTrait::getVocabularyIds protected function Gets the vocabulary IDs used by products.
ProductCategoryTrait::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.