class OrderPurchasedEntity in Commerce Core 8.2

Provides the variation condition for orders.

Plugin annotation

@CommerceCondition(
  id = "order_purchased_entity",
  label = @Translation("Purchased entity"),
  display_label = @Translation("Order contains specific purchased item"),
  category = @Translation("Purchased items"),
  entity_type = "commerce_order",
  weight = -1,
  deriver = "Drupal\commerce_order\Plugin\Commerce\Condition\PurchasedEntityConditionDeriver"
)

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\PurchasedEntityConditionBase implements PurchasableEntityConditionInterface, ContainerFactoryPluginInterface
        • class \Drupal\commerce_order\Plugin\Commerce\Condition\OrderPurchasedEntity

1 file declares its use of OrderPurchasedEntity

OrderPurchasedEntityTest.php in modules/order/tests/src/Unit/Plugin/Commerce/Condition/OrderPurchasedEntityTest.php

File

modules/order/src/Plugin/Commerce/Condition/OrderPurchasedEntity.php, line 21

Namespace

Drupal\commerce_order\Plugin\Commerce\Condition

class OrderPurchasedEntity extends PurchasedEntityConditionBase {

  /**
   * {@inheritdoc}
   */
  public function evaluate(EntityInterface $entity) {
    $this
      ->assertEntity($entity);
    assert($entity instanceof OrderInterface);
    foreach ($entity
      ->getItems() as $order_item) {
      if ($this
        ->isValid($order_item
        ->getPurchasedEntity())) {
        return TRUE;
      }
    }
    return FALSE;
  }

}

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.
OrderPurchasedEntity::evaluate	public	function	Evaluates the condition. Overrides ConditionInterface::evaluate
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.
PurchasedEntityConditionBase::$entityTypeManager	protected	property	The entity type manager.
PurchasedEntityConditionBase::$entityUuidMapper	protected	property	The entity UUID mapper.
PurchasedEntityConditionBase::buildConfigurationForm	public	function	Form constructor. Overrides ConditionBase::buildConfigurationForm
PurchasedEntityConditionBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PurchasedEntityConditionBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConditionBase::defaultConfiguration
PurchasedEntityConditionBase::getPurchasableEntities	public	function	Gets the configured purchasable entities. Overrides PurchasableEntityConditionInterface::getPurchasableEntities
PurchasedEntityConditionBase::getPurchasableEntityIds	public	function	Gets the configured purchasable entity IDS. Overrides PurchasableEntityConditionInterface::getPurchasableEntityIds
PurchasedEntityConditionBase::getPurchasableEntityType	protected	function	Gets the purchasable entity type.
PurchasedEntityConditionBase::isValid	protected	function	Determines whether the given purchasable entity is "valid".
PurchasedEntityConditionBase::submitConfigurationForm	public	function	Form submission handler. Overrides ConditionBase::submitConfigurationForm
PurchasedEntityConditionBase::__construct	public	function	Constructs a new PurchasedEntityConditionBase object. Overrides ConditionBase::__construct
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.