class PriceListRepository in Commerce Pricelist 8.2

Hierarchy

class \Drupal\commerce_pricelist\PriceListRepository implements PriceListRepositoryInterface

Expanded class hierarchy of PriceListRepository

1 string reference to 'PriceListRepository'

commerce_pricelist.services.yml in ./commerce_pricelist.services.yml: commerce_pricelist.services.yml

1 service uses PriceListRepository

commerce_pricelist.repository in ./commerce_pricelist.services.yml: Drupal\commerce_pricelist\PriceListRepository

File

src/PriceListRepository.php, line 11

Namespace

Drupal\commerce_pricelist

View source

class PriceListRepository implements PriceListRepositoryInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * A static cache of loaded price list items.
   *
   * @var array
   */
  protected $priceListItems = [];

  /**
   * A static cache of loaded price list IDs.
   *
   * @var array
   */
  protected $priceListIds = [];

  /**
   * Constructs a new PriceListRepository.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function loadItem(PurchasableEntityInterface $entity, $quantity, Context $context) {
    $price_list_items = $this
      ->loadItems($entity, $context);
    if (empty($price_list_items)) {
      return NULL;
    }

    /** @var  \Drupal\commerce_pricelist\Entity\PriceListItemInterface[] $price_list_items */
    $price_list_items = array_filter($price_list_items, function ($price_list_item) use ($quantity) {
      return $price_list_item
        ->getQuantity() <= $quantity;
    });
    $price_list_ids = $this
      ->loadPriceListIds($entity
      ->getEntityTypeId(), $context);
    $price_list_item = $this
      ->selectPriceListItem($price_list_items, $price_list_ids);
    return $price_list_item;
  }

  /**
   * {@inheritdoc}
   */
  public function loadItems(PurchasableEntityInterface $entity, Context $context) {
    $customer_id = $context
      ->getCustomer()
      ->id();
    $store_id = $context
      ->getStore()
      ->id();
    $date = DrupalDateTime::createFromTimestamp($context
      ->getTime(), $context
      ->getStore()
      ->getTimezone());
    $now = $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    $cache_key = implode(':', [
      $entity
        ->id(),
      $customer_id,
      $store_id,
      $now,
    ]);
    if (array_key_exists($cache_key, $this->priceListItems)) {
      return $this->priceListItems[$cache_key];
    }
    $price_list_ids = $this
      ->loadPriceListIds($entity
      ->getEntityTypeId(), $context);
    if (empty($price_list_ids)) {
      $this->priceListItems[$cache_key] = [];
      return [];
    }
    $price_list_item_storage = $this->entityTypeManager
      ->getStorage('commerce_pricelist_item');
    $query = $price_list_item_storage
      ->getQuery();
    $query
      ->condition('type', $entity
      ->getEntityTypeId())
      ->condition('price_list_id', $price_list_ids, 'IN')
      ->condition('purchasable_entity', $entity
      ->id())
      ->condition('status', TRUE)
      ->addTag('commerce_pricelist_item_query')
      ->addMetaData('price_list_ids', $price_list_ids)
      ->addMetaData('customer_id', $customer_id)
      ->addMetaData('store_id', $store_id)
      ->addMetaData('context', $context)
      ->sort('quantity', 'ASC');
    $result = $query
      ->execute();
    $price_list_items = [];
    if (!empty($result)) {
      $price_list_items = $price_list_item_storage
        ->loadMultiple($result);
    }
    $this->priceListItems[$cache_key] = $price_list_items;
    return $price_list_items;
  }

  /**
   * Selects the best matching price list item, based on quantity and weight.
   *
   * Assumes that price list items are ordered by quantity, and that
   * price list IDs are ordered by weight.
   *
   * @param \Drupal\commerce_pricelist\Entity\PriceListItemInterface[] $price_list_items
   *   The price list items.
   * @param int[] $price_list_ids
   *   The price list IDs.
   *
   * @return \Drupal\commerce_pricelist\Entity\PriceListItemInterface
   *   The selected price list item.
   */
  protected function selectPriceListItem(array $price_list_items, array $price_list_ids) {
    if (count($price_list_items) > 1) {

      // Multiple matching price list items found.
      // First, reduce to one per price list, by selecting the quantity tier.
      $grouped_price_list_items = [];
      foreach ($price_list_items as $price_list_item) {
        $price_list_id = $price_list_item
          ->getPriceListId();
        $grouped_price_list_items[$price_list_id] = $price_list_item;
      }

      // Then, select the one whose price list has the smallest weight.
      $price_list_weights = [];
      foreach ($grouped_price_list_items as $price_list_id => $price_list_item) {
        $price_list_weight = array_search($price_list_id, $price_list_ids);
        $price_list_weights[$price_list_id] = $price_list_weight;
      }
      asort($price_list_weights);
      $sorted_price_list_ids = array_keys($price_list_weights);
      $price_list_id = reset($sorted_price_list_ids);
      $price_list_item = $grouped_price_list_items[$price_list_id];
    }
    else {
      $price_list_item = reset($price_list_items);
    }
    return $price_list_item;
  }

  /**
   * Loads the available price list IDs for the given bundle and context.
   *
   * @param string $bundle
   *   The price list bundle.
   * @param \Drupal\commerce\Context $context
   *   The context.
   *
   * @return int[]
   *   The price list IDs.
   */
  protected function loadPriceListIds($bundle, Context $context) {
    $customer_id = $context
      ->getCustomer()
      ->id();
    $store_id = $context
      ->getStore()
      ->id();
    $date = DrupalDateTime::createFromTimestamp($context
      ->getTime(), $context
      ->getStore()
      ->getTimezone());
    $now = $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    $cache_key = implode(':', [
      $bundle,
      $customer_id,
      $store_id,
      $now,
    ]);
    if (array_key_exists($cache_key, $this->priceListIds)) {
      return $this->priceListIds[$cache_key];
    }
    $price_list_storage = $this->entityTypeManager
      ->getStorage('commerce_pricelist');
    $query = $price_list_storage
      ->getQuery();
    $query
      ->condition('type', $bundle)
      ->condition('stores', [
      $store_id,
    ], 'IN')
      ->condition($query
      ->orConditionGroup()
      ->condition('customers', $customer_id)
      ->notExists('customers'))
      ->condition($query
      ->orConditionGroup()
      ->condition('customer_roles', $context
      ->getCustomer()
      ->getRoles(), 'IN')
      ->notExists('customer_roles'))
      ->condition('start_date', $now, '<=')
      ->condition($query
      ->orConditionGroup()
      ->condition('end_date', $now, '>')
      ->notExists('end_date'))
      ->condition('status', TRUE)
      ->sort('weight', 'ASC')
      ->sort('id', 'DESC')
      ->addTag('commerce_pricelist_query')
      ->addMetaData('customer_id', $customer_id)
      ->addMetaData('store_id', $store_id)
      ->addMetaData('context', $context);
    $result = $query
      ->execute();
    $price_list_ids = array_values($result);
    $this->priceListIds[$cache_key] = $price_list_ids;
    return $price_list_ids;
  }

}

Members

Name	Modifiers	Type	Description
PriceListRepository::$entityTypeManager	protected	property	The entity type manager.
PriceListRepository::$priceListIds	protected	property	A static cache of loaded price list IDs.
PriceListRepository::$priceListItems	protected	property	A static cache of loaded price list items.
PriceListRepository::loadItem	public	function	Loads the price list item for the given purchasable entity. Overrides PriceListRepositoryInterface::loadItem
PriceListRepository::loadItems	public	function	Loads the price list items for the given purchasable entity. Overrides PriceListRepositoryInterface::loadItems
PriceListRepository::loadPriceListIds	protected	function	Loads the available price list IDs for the given bundle and context.
PriceListRepository::selectPriceListItem	protected	function	Selects the best matching price list item, based on quantity and weight.
PriceListRepository::__construct	public	function	Constructs a new PriceListRepository.

You are here

class PriceListRepository in Commerce Pricelist 8.2

Hierarchy

File

Namespace

Members

API Navigation