Issue #2867019 by bojanz: Clean up the integration between coupons and promotions

Author: bojanz

modules/promotion/commerce_promotion.services.yml

@@ -12,12 +12,6 @@ services:
     tags:
       - { name: commerce_order.order_processor, priority: 50 }
 
-  commerce_promotion.coupon_order_processor:
-    class: Drupal\commerce_promotion\CouponOrderProcessor
-    arguments: ['@entity_type.manager']
-    tags:
-      - { name: commerce_order.order_processor, priority: 50 }
-
   commerce_promotion.usage:
     class: Drupal\commerce_promotion\PromotionUsage
     arguments: ['@database']

modules/promotion/src/CouponOrderProcessor.php

@@ -4,8 +4,6 @@
 
 use Drupal\commerce\Element\CommerceElementBase;
 use Drupal\commerce_order\Entity\OrderInterface;
-use Drupal\commerce_promotion\Entity\CouponInterface;
-use Drupal\commerce_promotion\Entity\PromotionInterface;
 use Drupal\Component\Utility\NestedArray;
 use Drupal\Core\Form\FormStateInterface;
 
@@ -219,51 +217,16 @@ public static function validateForm(array &$element, FormStateInterface $form_st
         return;
       }
     }
-
-    $order_type_storage = $entity_type_manager->getStorage('commerce_order_type');
-    /** @var \Drupal\commerce_promotion\PromotionStorageInterface $promotion_storage */
-    $promotion_storage = $entity_type_manager->getStorage('commerce_promotion');
-    /** @var \Drupal\commerce_order\Entity\OrderTypeInterface $order_type */
-    $order_type = $order_type_storage->load($order->bundle());
-    $promotion = $promotion_storage->loadByCoupon($order_type, $order->getStore(), $coupon);
-    if (empty($promotion)) {
+    if (!$coupon->available($order)) {
       $form_state->setErrorByName($code_path, t('Coupon is invalid'));
       return;
     }
-    if (!self::couponApplies($order, $promotion, $coupon)) {
+    if (!$coupon->getPromotion()->applies($order)) {
       $form_state->setErrorByName($code_path, t('Coupon is invalid'));
       return;
     }
 
     $form_state->setValueForElement($element, $coupon);
   }
 
-  /**
-   * Checks whether a coupon applies.
-   *
-   * @param \Drupal\commerce_order\Entity\OrderInterface $order
-   *   The order.
-   * @param \Drupal\commerce_promotion\Entity\PromotionInterface $promotion
-   *   The promotion.
-   * @param \Drupal\commerce_promotion\Entity\CouponInterface $coupon
-   *   The coupon.
-   *
-   * @return bool
-   *   Returns TRUE if the coupon applies, FALSE otherwise.
-   */
-  protected static function couponApplies(OrderInterface $order, PromotionInterface $promotion, CouponInterface $coupon) {
-    if ($promotion->applies($order)) {
-      return TRUE;
-    }
-    else {
-      foreach ($order->getItems() as $orderItem) {
-        if ($promotion->applies($orderItem)) {
-          return TRUE;
-        }
-      }
-    }
-
-    return FALSE;
-  }
-
 }

modules/promotion/src/Element/CouponRedemptionForm.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\commerce_promotion\Entity;
 
+use Drupal\commerce_order\Entity\OrderInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
 use Drupal\Core\Entity\ContentEntityBase;
 use Drupal\Core\Entity\EntityTypeInterface;
@@ -71,18 +72,32 @@ public function setCode($code) {
   /**
    * {@inheritdoc}
    */
-  public function isActive() {
+  public function isEnabled() {
     return (bool) $this->getEntityKey('status');
   }
 
   /**
    * {@inheritdoc}
    */
-  public function setActive($active) {
-    $this->set('status', (bool) $active);
+  public function setEnabled($enabled) {
+    $this->set('status', (bool) $enabled);
     return $this;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function available(OrderInterface $order) {
+    if (!$this->isEnabled()) {
+      return FALSE;
+    }
+    if (!$this->getPromotion()->available($order)) {
+      return FALSE;
+    }
+
+    return TRUE;
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -99,7 +114,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
 
     $fields['code'] = BaseFieldDefinition::create('string')
       ->setLabel(t('Coupon code'))
-      ->setDescription(t('The Coupon entity code.'))
+      ->setDescription(t('The unique, machine-readable identifier for a coupon.'))
       ->addConstraint('CouponCode')
       ->setSettings([
         'max_length' => 50,
@@ -119,14 +134,18 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDisplayConfigurable('view', TRUE);
 
     $fields['status'] = BaseFieldDefinition::create('boolean')
-      ->setLabel(t('Active status'))
-      ->setDescription(t('A boolean indicating whether the Coupon is active.'))
+      ->setLabel(t('Status'))
+      ->setDescription(t('Whether the coupon is enabled.'))
       ->setDefaultValue(TRUE)
-      ->setDisplayOptions('form', [
-        'type' => 'boolean_checkbox',
-        'weight' => 99,
+      ->setRequired(TRUE)
+      ->setSettings([
+        'on_label' => t('Enabled'),
+        'off_label' => t('Disabled'),
       ])
-      ->setDisplayConfigurable('form', TRUE);
+      ->setDisplayOptions('form', [
+        'type' => 'options_buttons',
+        'weight' => 0,
+      ]);
 
     return $fields;
   }

modules/promotion/src/Entity/Coupon.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\commerce_promotion\Entity;
 
+use Drupal\commerce_order\Entity\OrderInterface;
 use Drupal\Core\Entity\ContentEntityInterface;
 
 /**
@@ -39,28 +40,40 @@ public function getCode();
    * @param string $code
    *   The coupon code.
    *
-   * @return \Drupal\commerce_promotion\Entity\CouponInterface
-   *   The coupon.
+   * @return $this
    */
   public function setCode($code);
 
   /**
-   * Returns the coupon status indicator.
+   * Gets whether the coupon is enabled.
    *
    * @return bool
-   *   TRUE if the coupon is active.
+   *   TRUE if the coupon is enabled, FALSE otherwise.
    */
-  public function isActive();
+  public function isEnabled();
 
   /**
-   * Sets the status of a coupon.
+   * Sets whether the coupon is enabled.
    *
-   * @param bool $active
-   *   TRUE to make coupon active, FALSE to set it to inactive.
+   * @param bool $enabled
+   *   Whether the coupon is enabled.
    *
-   * @return \Drupal\commerce_promotion\Entity\CouponInterface
-   *   The coupon.
+   * @return $this
    */
-  public function setActive($active);
+  public function setEnabled($enabled);
+
+  /**
+   * Checks whether the coupon is available for the given order.
+   *
+   * Ensures that the parent promotion is available, the coupon
+   * is enabled, and the usage limits are respected.
+   *
+   * @param \Drupal\commerce_order\Entity\OrderInterface $order
+   *   The order.
+   *
+   * @return bool
+   *   TRUE if coupon is available, FALSE otherwise.
+   */
+  public function available(OrderInterface $order);
 
 }

modules/promotion/src/Entity/CouponInterface.php

@@ -280,8 +280,8 @@ public function getEndDate() {
   /**
    * {@inheritdoc}
    */
-  public function setEndDate(DrupalDateTime $end_date) {
-    $this->get('end_date')->value = $end_date->format('Y-m-d');
+  public function setEndDate(DrupalDateTime $end_date = NULL) {
+    $this->get('end_date')->value = $end_date ? $end_date->format('Y-m-d') : NULL;
     return $this;
   }
 
@@ -333,6 +333,38 @@ public function setWeight($weight) {
     return $this;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function available(OrderInterface $order) {
+    if (!$this->isEnabled()) {
+      return FALSE;
+    }
+    if (!in_array($order->bundle(), $this->getOrderTypeIds())) {
+      return FALSE;
+    }
+    if (!in_array($order->getStoreId(), $this->getStoreIds())) {
+      return FALSE;
+    }
+    $time = \Drupal::service('commerce.time')->getRequestTime();
+    if ($this->getStartDate()->format('U') > $time) {
+      return FALSE;
+    }
+    $end_date = $this->getEndDate();
+    if ($end_date && $end_date->format('U') <= $time) {
+      return FALSE;
+    }
+    if ($usage_limit = $this->getUsageLimit()) {
+      /** @var \Drupal\commerce_promotion\PromotionUsageInterface $usage */
+      $usage = \Drupal::service('commerce_promotion.usage');
+      if ($usage_limit <= $usage->getUsage($this)) {
+        return FALSE;
+      }
+    }
+
+    return TRUE;
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -585,7 +617,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDefaultValue(TRUE)
       ->setRequired(TRUE)
       ->setSettings([
-        'on_label' => t('Active'),
+        'on_label' => t('Enabled'),
         'off_label' => t('Disabled'),
       ])
       ->setDisplayOptions('form', [

modules/promotion/src/Entity/Promotion.php

@@ -207,7 +207,7 @@ public function getEndDate();
    *
    * @return $this
    */
-  public function setEndDate(DrupalDateTime $end_date);
+  public function setEndDate(DrupalDateTime $end_date = NULL);
 
   /**
    * Gets the promotion compatibility.
@@ -264,7 +264,25 @@ public function getWeight();
   public function setWeight($weight);
 
   /**
-   * Checks whether the promotion entity can be applied.
+   * Checks whether the promotion is available for the given order.
+   *
+   * Ensures that the order type and store match the promotion's,
+   * that the promotion is enabled, the current date matches the
+   * start and end dates, and the usage limits are respected.
+   *
+   * @param \Drupal\commerce_order\Entity\OrderInterface $order
+   *   The order.
+   *
+   * @return bool
+   *   TRUE if promotion is available, FALSE otherwise.
+   */
+  public function available(OrderInterface $order);
+
+  /**
+   * Checks whether the promotion can be applied to the given order.
+   *
+   * Ensures that the promotion is compatible with other
+   * promotions on the order, and that the conditions pass.
    *
    * @param \Drupal\commerce_order\Entity\OrderInterface $order
    *   The order.