2770757 implement promotion conditions

modules/order/src/Entity/LineItem.php

@@ -102,7 +102,7 @@ public function setTitle($title) {
    * {@inheritdoc}
    */
   public function getQuantity() {
-    return $this->get('quantity')->value;
+    return (string) $this->get('quantity')->value;
   }
 
   /**

modules/promotion/commerce_promotion.services.yml

@@ -2,3 +2,6 @@ services:
   plugin.manager.commerce_promotion_offer:
     class: Drupal\commerce_promotion\PromotionOfferManager
     arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@entity_type.manager']
+  plugin.manager.commerce_promotion_condition:
+    class: Drupal\commerce_promotion\PromotionConditionManager
+    arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@entity_type.manager']

modules/promotion/src/Annotation/CommercePromotionCondition.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Drupal\commerce_promotion\Annotation;
+
+use Drupal\Core\Condition\Annotation\Condition;
+
+/**
+ * Defines the promotion condition plugin annotation object.
+ *
+ * Plugin namespace: Plugin\Commerce\PromotionCondition.
+ *
+ * @Annotation
+ */
+class CommercePromotionCondition extends Condition {
+
+  /**
+   * The target entity type this action applies to.
+   *
+   * For example, this should be 'commerce_order' or 'commerce_line_item'.
+   *
+   * @var string
+   */
+  public $target_entity_type;
+
+}

modules/promotion/src/Entity/Promotion.php

@@ -236,13 +236,36 @@ public function setEnabled($enabled) {
     return $this;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function applies(EntityInterface $entity) {
+    $entity_type_id = $entity->getEntityTypeId();
+    // @todo should whatever invokes this method be providing the context?
+    $context = new Context(new ContextDefinition('entity:' . $entity_type_id), $entity);
+
+    // Execute each plugin, this is an AND operation.
+    // @todo support OR operations.
+    /** @var \Drupal\commerce\Plugin\Field\FieldType\PluginItem $item */
+    foreach ($this->get('conditions') as $item) {
+      /** @var \Drupal\commerce_promotion\Plugin\Commerce\PromotionCondition\PromotionConditionInterface $condition */
+      $condition = $item->getTargetInstance([$entity_type_id => $context]);
+      if (!$condition->evaluate()) {
+        return FALSE;
+      }
+    }
+
+    return TRUE;
+  }
+
   /**
    * {@inheritdoc}
    */
   public function apply(EntityInterface $entity) {
     $entity_type_id = $entity->getEntityTypeId();
     // @todo should whatever invokes this method be providing the context?
     $context = new Context(new ContextDefinition('entity:' . $entity_type_id), $entity);
+
     /** @var \Drupal\commerce_promotion\Plugin\Commerce\PromotionOffer\PromotionOfferInterface $offer */
     $offer = $this->get('offer')->first()->getTargetInstance([$entity_type_id => $context]);
     $offer->execute();
@@ -320,6 +343,15 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
         'weight' => 3,
       ]);
 
+    $fields['conditions'] = BaseFieldDefinition::create('commerce_plugin_item:commerce_promotion_condition')
+      ->setLabel(t('Conditions'))
+      ->setCardinality(BaseFieldDefinition::CARDINALITY_UNLIMITED)
+      ->setRequired(FALSE)
+      ->setDisplayOptions('form', [
+        'type' => 'commerce_plugin_select',
+        'weight' => 3,
+      ]);
+
     $fields['coupons'] = BaseFieldDefinition::create('entity_reference')
       ->setLabel(t('Coupons'))
       ->setDescription(t('Coupons which allow promotion to be redeemed.'))

modules/promotion/src/Entity/PromotionInterface.php

@@ -214,7 +214,18 @@ public function isEnabled();
   public function setEnabled($enabled);
 
   /**
-   * Applies the promotion to an entity.
+   * Checks whether the promotion entity can be applied.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $entity
+   *   The entity.
+   *
+   * @return bool
+   *   TRUE if promotion can be applied, or false if conditions failed.
+   */
+  public function applies(EntityInterface $entity);
+
+  /**
+   * Apply the promotion to an entity.
    *
    * @param \Drupal\Core\Entity\EntityInterface $entity
    *   The entity.

modules/promotion/src/Plugin/Commerce/PromotionCondition/OrderTotalPrice.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Drupal\commerce_promotion\Plugin\Commerce\PromotionCondition;
+
+use Drupal\commerce_price\Price;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Provides an 'Order: Total amount comparison' condition.
+ *
+ * @CommercePromotionCondition(
+ *   id = "commerce_promotion_order_total_price",
+ *   label = @Translation("Total amount"),
+ *   target_entity_type = "commerce_order",
+ * )
+ */
+class OrderTotalPrice extends PromotionConditionBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [
+      'amount' => NULL,
+      // @todo expose the operator in form.
+      'operator' => '>',
+    ] + parent::defaultConfiguration();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    $form += parent::buildConfigurationForm($form, $form_state);
+
+    $default_price = NULL;
+    if (!empty($this->configuration['amount']['amount'])) {
+      $default_price = new Price($this->configuration['amount']['amount'], $this->configuration['amount']['currency_code']);
+    }
+
+    $form['amount'] = [
+      '#type' => 'commerce_price',
+      '#title' => t('Amount'),
+      '#default_value' => $default_price,
+      '#required' => TRUE,
+    ];
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function evaluate() {
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $this->getTargetEntity();
+    /** @var \Drupal\commerce_price\Price $total_price */
+    $total_price = $order->getTotalPrice();
+    /** @var \Drupal\commerce_price\Price $comparison_price */
+    $comparison_price = $this->configuration['amount'];
+
+    switch ($this->configuration['operator']) {
+      case '==':
+        return $total_price->equals($comparison_price);
+
+      case '>=':
+        return $total_price->greaterThanOrEqual($comparison_price);
+
+      case '>':
+        return $total_price->greaterThan($comparison_price);
+
+      case '<=':
+        return $total_price->lessThanOrEqual($comparison_price);
+
+      case '<':
+        return $total_price->lessThan($comparison_price);
+
+      default:
+        throw new \InvalidArgumentException("Invalid operator {$this->configuration['operator']}");
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function summary() {
+    return $this->t('Compares the order total amount.');
+  }
+
+}

modules/promotion/src/Plugin/Commerce/PromotionCondition/PromotionConditionBase.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\commerce_promotion\Plugin\Commerce\PromotionCondition;
+
+use Drupal\Core\Condition\ConditionPluginBase;
+
+/**
+ * Base class for Promotion Condition plugins.
+ */
+abstract class PromotionConditionBase extends ConditionPluginBase implements PromotionConditionInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getTargetEntityType() {
+    return $this->pluginDefinition['target_entity_type'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getTargetEntity() {
+    return $this->getContextValue($this->getTargetEntityType());
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function execute() {
+    $result = $this->evaluate();
+    return $this->isNegated() ? !$result : $result;
+  }
+
+}

modules/promotion/src/Plugin/Commerce/PromotionCondition/PromotionConditionInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Drupal\commerce_promotion\Plugin\Commerce\PromotionCondition;
+
+use Drupal\Core\Condition\ConditionInterface;
+
+/**
+ * Defines an interface for Condition plugins.
+ */
+interface PromotionConditionInterface extends ConditionInterface {
+
+  /**
+   * Gets the entity type the condition is for.
+   *
+   * @return string
+   *   The entity type it applies to.
+   */
+  public function getTargetEntityType();
+
+  /**
+   * Get the target entity for the offer.
+   *
+   * @return \Drupal\Core\Entity\EntityInterface
+   *   The target entity.
+   */
+  public function getTargetEntity();
+
+}

modules/promotion/src/Plugin/Commerce/PromotionOffer/ProductPercentageOff.php

@@ -19,7 +19,7 @@ class ProductPercentageOff extends PercentageOffBase {
   public function execute() {
     /** @var \Drupal\commerce_order\Entity\LineItemInterface $line_item */
     $line_item = $this->getTargetEntity();
-    $price_amount = $line_item->getTotalPrice()->multiply($this->getAmount());
+    $price_amount = $line_item->getUnitPrice()->multiply($this->getAmount());
     $this->applyAdjustment($line_item, $price_amount);
   }
 

modules/promotion/src/Plugin/Commerce/PromotionOffer/PromotionOfferBase.php

@@ -28,15 +28,15 @@ public function __construct(array $configuration, $plugin_id, $plugin_definition
   /**
    * {@inheritdoc}
    */
-  public function appliesTo() {
+  public function getTargetEntityType() {
     return $this->pluginDefinition['target_entity_type'];
   }
 
   /**
    * {@inheritdoc}
    */
   public function getTargetEntity() {
-    return $this->getContextValue($this->appliesTo());
+    return $this->getContextValue($this->getTargetEntityType());
   }
 
   /**

modules/promotion/src/Plugin/Commerce/PromotionOffer/PromotionOfferInterface.php

@@ -19,12 +19,12 @@ interface PromotionOfferInterface extends ExecutableInterface, PluginFormInterfa
   const LINE_ITEM = 'commerce_line_item';
 
   /**
-   * Returns what entity the promotion offer applies to.
+   * Gets the entity type the offer is for.
    *
    * @return string
    *   The entity type it applies to.
    */
-  public function appliesTo();
+  public function getTargetEntityType();
 
   /**
    * Get the target entity for the offer.