PromotionStorageInterface.php

<?php

namespace Drupal\commerce_promotion;

use Drupal\commerce_order\Entity\OrderTypeInterface;
use Drupal\commerce_store\Entity\StoreInterface;
use Drupal\Core\Entity\ContentEntityStorageInterface;

/**
 * Defines the interface for promotion storage.
 */
interface PromotionStorageInterface extends ContentEntityStorageInterface {

  /**
   * Loads the available promotions for the given order type and store.
   *
   * @param \Drupal\commerce_order\Entity\OrderTypeInterface $order_type
   *   The order type.
   * @param \Drupal\commerce_store\Entity\StoreInterface $store
   *   The store.
   *
   * @return \Drupal\commerce_promotion\Entity\PromotionInterface[]
   *   The available promotions.
   */
  public function loadAvailable(OrderTypeInterface $order_type, StoreInterface $store);

  /**
   * Return active promotions that have passed their end date.
   *
   * @return \Drupal\commerce_promotion\Entity\PromotionInterface[]
   *   The expired promotion entities.
   */
  public function loadExpired();

  /**
   * Returns active promotions which have a met their maximum usage.
   *
   * @return \Drupal\commerce_promotion\Entity\PromotionInterface[]
   *   Promotions with maxed usage.
   */
  public function loadMaxedUsage();

}