class LocalStockChecker in Commerce Stock 8

The stock checker implementation for the local stock module.

Hierarchy

class \Drupal\commerce_stock_local\LocalStockChecker implements StockCheckInterface

Expanded class hierarchy of LocalStockChecker

1 string reference to 'LocalStockChecker'

commerce_stock_local.services.yml in modules/local_storage/commerce_stock_local.services.yml: modules/local_storage/commerce_stock_local.services.yml

1 service uses LocalStockChecker

commerce_stock.local_stock_checker in modules/local_storage/commerce_stock_local.services.yml: Drupal\commerce_stock_local\LocalStockChecker

File

modules/local_storage/src/LocalStockChecker.php, line 14

Namespace

Drupal\commerce_stock_local

View source

class LocalStockChecker implements StockCheckInterface {

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The location storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $locationStorage;

  /**
   * Constructs the local stock checker.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager.
   */
  public function __construct(Connection $database, EntityTypeManagerInterface $entity_type_manager) {
    $this->database = $database;
    $this->locationStorage = $entity_type_manager
      ->getStorage('commerce_stock_location');
  }

  /**
   * Creates an instance of the local stock checker.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The DI container.
   *
   * @return static
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Gets stock level for a given location and purchasable entity.
   *
   * @param int $location_id
   *   Location id.
   * @param \Drupal\commerce\PurchasableEntityInterface $entity
   *   Purchasable entity.
   *
   * @return array
   *   An array of 'qty' and 'last_transaction_id' values.
   */
  public function getLocationStockLevel($location_id, PurchasableEntityInterface $entity) {
    $result = $this->database
      ->select('commerce_stock_location_level', 'll')
      ->fields('ll')
      ->condition('location_id', $location_id)
      ->condition('entity_id', $entity
      ->id())
      ->condition('entity_type', $entity
      ->getEntityTypeId())
      ->execute()
      ->fetch();
    return [
      'qty' => $result ? $result->qty : 0,
      'last_transaction' => $result ? $result->last_transaction_id : 0,
    ];
  }

  /**
   * Gets the last transaction id for a given location and purchasable entity.
   *
   * @param int $location_id
   *   Location id.
   * @param \Drupal\commerce\PurchasableEntityInterface $entity
   *   The purchasable entity.
   *
   * @return int
   *   The last location stock transaction id.
   */
  public function getLocationStockTransactionLatest($location_id, PurchasableEntityInterface $entity) {
    $query = $this->database
      ->select('commerce_stock_transaction')
      ->condition('location_id', $location_id)
      ->condition('entity_id', $entity
      ->id())
      ->condition('entity_type', $entity
      ->getEntityTypeId());
    $query
      ->addExpression('MAX(id)', 'max_id');
    $result = $query
      ->execute()
      ->fetch();
    return $result && $result->max_id ? $result->max_id : 0;
  }

  /**
   * Gets the sum of all stock transactions between a range of transactions.
   *
   * @param int $location_id
   *   The location id.
   * @param \Drupal\commerce\PurchasableEntityInterface $entity
   *   The purchasable entity.
   * @param int $min
   *   The minimum transaction number.
   * @param int $max
   *   The maximum transaction number.
   *
   * @return int
   *   The sum of stock transactions for a given location and purchasable
   *   entity.
   */
  public function getLocationStockTransactionSum($location_id, PurchasableEntityInterface $entity, $min, $max) {
    $query = $this->database
      ->select('commerce_stock_transaction', 'txn')
      ->fields('txn', [
      'location_id',
    ])
      ->condition('location_id', $location_id)
      ->condition('entity_id', $entity
      ->id())
      ->condition('entity_type', $entity
      ->getEntityTypeId())
      ->condition('id', $min, '>');
    if ($max) {
      $query
        ->condition('id', $max, '<=');
    }
    $query
      ->addExpression('SUM(qty)', 'qty');
    $query
      ->groupBy('location_id');
    $result = $query
      ->execute()
      ->fetch();
    return $result ? $result->qty : 0;
  }

  /**
   * {@inheritdoc}
   */
  public function getTotalStockLevel(PurchasableEntityInterface $entity, array $locations) {
    $location_info = $this
      ->getLocationsStockLevels($entity, $locations);
    $total = 0;
    foreach ($location_info as $location) {
      $total += $location['qty'] + $location['transactions_qty'];
    }
    return $total;
  }

  /**
   * Gets the stock levels for a set of locations.
   *
   * @param \Drupal\commerce\PurchasableEntityInterface $entity
   *   The purchasable entity.
   * @param \Drupal\commerce_stock\StockLocationInterface[] $locations
   *   The stock locations.
   *
   * @return array
   *   Stock level information indexed by location id with these values:
   *     - 'qty': The quantity.
   *     - 'last_transaction': The id of the last transaction.
   */
  public function getLocationsStockLevels(PurchasableEntityInterface $entity, array $locations) {
    $location_levels = [];

    /** @var \Drupal\commerce_stock\StockLocationInterface $location */
    foreach ($locations as $location) {
      $location_id = $location
        ->getId();
      $location_level = $this
        ->getLocationStockLevel($location_id, $entity);
      $latest_txn = $this
        ->getLocationStockTransactionLatest($location_id, $entity);
      $transactions_qty = $this
        ->getLocationStockTransactionSum($location_id, $entity, $location_level['last_transaction'], $latest_txn);
      $location_levels[$location_id] = [
        'qty' => $location_level['qty'],
        'transactions_qty' => $transactions_qty,
      ];
    }
    return $location_levels;
  }

  /**
   * {@inheritdoc}
   */
  public function getIsInStock(PurchasableEntityInterface $entity, array $locations) {
    return $this
      ->getTotalStockLevel($entity, $locations) > 0;
  }

  /**
   * {@inheritdoc}
   */
  public function getIsAlwaysInStock(PurchasableEntityInterface $entity) {
    return $entity
      ->get('commerce_stock_always_in_stock') && $entity
      ->get('commerce_stock_always_in_stock')->value == TRUE;
  }

  /**
   * Gets the locations. This is an old implementation of the now changed
   * interface.
   *
   * @deprecated in commerce_stock:8.x-1.0 and is
   * removed from commerce_stock:8.x-2.0. Use the StockLocationStorage service instead.
   */
  public function getLocationList($return_active_only = TRUE) {
    $locations = $this->locationStorage
      ->loadMultiple();
    if ($return_active_only) {
      $active = [];

      /** @var StockLocationInterface $location */
      foreach ($locations as $location) {
        if ($location
          ->isActive()) {
          $active[] = $location;
        }
      }
      return $active;
    }
    return $locations;
  }

}

Members

Name	Modifiers	Type	Description
LocalStockChecker::$database	protected	property	The database connection.
LocalStockChecker::$locationStorage	protected	property	The location storage.
LocalStockChecker::create	public static	function	Creates an instance of the local stock checker.
LocalStockChecker::getIsAlwaysInStock	public	function	Check if entity is always in stock. Overrides StockCheckInterface::getIsAlwaysInStock
LocalStockChecker::getIsInStock	public	function	Check if purchasable entity is in stock. Overrides StockCheckInterface::getIsInStock
LocalStockChecker::getLocationList Deprecated	public	function	Gets the locations. This is an old implementation of the now changed interface.
LocalStockChecker::getLocationsStockLevels	public	function	Gets the stock levels for a set of locations.
LocalStockChecker::getLocationStockLevel	public	function	Gets stock level for a given location and purchasable entity.
LocalStockChecker::getLocationStockTransactionLatest	public	function	Gets the last transaction id for a given location and purchasable entity.
LocalStockChecker::getLocationStockTransactionSum	public	function	Gets the sum of all stock transactions between a range of transactions.
LocalStockChecker::getTotalStockLevel	public	function	Gets the stock level. Overrides StockCheckInterface::getTotalStockLevel
LocalStockChecker::__construct	public	function	Constructs the local stock checker.

You are here

class LocalStockChecker in Commerce Stock 8

Hierarchy

File

Namespace

Members

API Navigation