class XquantityStockOrderEventSubscriber in Commerce Extended Quantity 8

Commerce order event subscriber.

Hierarchy

• class \Drupal\xquantity_stock\EventSubscriber\XquantityStockOrderEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'XquantityStockOrderEventSubscriber'

xquantity_stock.services.yml in modules/xquantity_stock/xquantity_stock.services.yml

modules/xquantity_stock/xquantity_stock.services.yml

1 service uses XquantityStockOrderEventSubscriber

xquantity_stock.order in modules/xquantity_stock/xquantity_stock.services.yml

Drupal\xquantity_stock\EventSubscriber\XquantityStockOrderEventSubscriber

File

modules/xquantity_stock/src/EventSubscriber/XquantityStockOrderEventSubscriber.php, line 21

Namespace

Drupal\xquantity_stock\EventSubscriber

class XquantityStockOrderEventSubscriber implements EventSubscriberInterface {

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The availability manager.
   *
   * @var \Drupal\commerce_order\AvailabilityCheckerInterface
   */
  public $availabilityManager;

  /**
   * Constructs a new OrderEventSubscriber object.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param \Drupal\Core\Session\AccountProxyInterface $user
   *   The current user.
   * @param \Drupal\commerce_order\AvailabilityCheckerInterface $availability_manager
   *   The availability manager.
   */
  public function __construct(RouteMatchInterface $route_match, AccountProxyInterface $user, AvailabilityCheckerInterface $availability_manager) {
    $this->routeMatch = $route_match;
    $this->currentUser = $user;
    $this->availabilityManager = $availability_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events = [
      'commerce_order.cancel.post_transition' => [
        'onOrderCancel',
        -100,
      ],
      OrderEvents::ORDER_PREDELETE => [
        'onOrderDelete',
        -100,
      ],
      OrderEvents::ORDER_ITEM_UPDATE => [
        'onOrderItemUpdate',
        -100,
      ],
      OrderEvents::ORDER_ITEM_DELETE => [
        'onOrderItemDelete',
        -100,
      ],
    ];
    return $events;
  }

  /**
   * Performs a stock transaction for an order Cancel event.
   *
   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
   *   The order workflow event.
   */
  public function onOrderCancel(WorkflowTransitionEvent $event) {
    $order = $event
      ->getEntity();
    foreach ($order
      ->getItems() as $order_item) {
      $this
        ->updateStock($order, $order_item, TRUE);
    }
  }

  /**
   * Performs a stock transaction on an order delete event.
   *
   * This happens on PREDELETE since the items are not available after DELETE.
   *
   * @param \Drupal\commerce_order\Event\OrderEvent $event
   *   The order event.
   */
  public function onOrderDelete(OrderEvent $event) {
    $order = $event
      ->getOrder();
    foreach ($order
      ->getItems() as $order_item) {
      $this
        ->updateStock($order, $order_item, TRUE);
    }
  }

  /**
   * Performs a stock transaction on an order item update.
   *
   * @param \Drupal\commerce_order\Event\OrderItemEvent $event
   *   The order item event.
   */
  public function onOrderItemUpdate(OrderItemEvent $event) {

    // Prevent on the Add to cart and Shopping cart update forms.
    if ($this->routeMatch
      ->getParameter('commerce_order')) {
      if (($order_item = $event
        ->getOrderItem()) && ($order = $order_item
        ->getOrder())) {
        $this
          ->updateStock($order, $order_item);
      }
    }
  }

  /**
   * Returns quantity to the stock when an order item is deleted.
   *
   * @param \Drupal\commerce_order\Event\OrderItemEvent $event
   *   The order item event.
   */
  public function onOrderItemDelete(OrderItemEvent $event) {
    $order_item = $event
      ->getOrderItem();

    // Do not run on order delete event as the order don't exist there.
    if ($order = $order_item
      ->getOrder()) {
      $this
        ->updateStock($order, $order_item, TRUE);
    }
  }

  /**
   * Calls xquantity_stock availability checker to update the entity stock.
   *
   * @param \Drupal\commerce_order\Entity\Order $order
   *   The commerce order.
   * @param \Drupal\commerce_order\Entity\OrderItem $order_item
   *   The commerce order item.
   * @param bool $delete
   *   Whether the order item is going to be deleted.
   */
  protected function updateStock(Order $order, OrderItem $order_item, $delete = FALSE) {
    $state = $order
      ->getState()->value;
    if ($state != 'canceled' && $state != 'completed') {
      $quantity = $delete ? '0' : $order_item
        ->getQuantity();
      $old = $delete ? $order_item
        ->getQuantity() : $order_item->original
        ->getQuantity();
      $context = new Context($this->currentUser, $order
        ->getStore(), time(), [
        'xquantity' => $delete ? 'delete' : 'update',
        'old' => $old,
      ]);
      $result = $this->availabilityManager
        ->check($order_item, $context, $quantity);
      if ($result
        ->isUnavailable()) {
        throw new \InvalidArgumentException("The quantity {$quantity} to update on the {$order_item->getTitle()} order item is not available on the stock.");
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
XquantityStockOrderEventSubscriber::$availabilityManager	public	property	The availability manager.
XquantityStockOrderEventSubscriber::$currentUser	protected	property	The current user.
XquantityStockOrderEventSubscriber::$routeMatch	protected	property	The route match.
XquantityStockOrderEventSubscriber::getSubscribedEvents	public static	function
XquantityStockOrderEventSubscriber::onOrderCancel	public	function	Performs a stock transaction for an order Cancel event.
XquantityStockOrderEventSubscriber::onOrderDelete	public	function	Performs a stock transaction on an order delete event.
XquantityStockOrderEventSubscriber::onOrderItemDelete	public	function	Returns quantity to the stock when an order item is deleted.
XquantityStockOrderEventSubscriber::onOrderItemUpdate	public	function	Performs a stock transaction on an order item update.
XquantityStockOrderEventSubscriber::updateStock	protected	function	Calls xquantity_stock availability checker to update the entity stock.
XquantityStockOrderEventSubscriber::__construct	public	function	Constructs a new OrderEventSubscriber object.