class LicenseMultiplesCartEventSubscriber in Commerce License 8.2

Ensures only 1 of each license may be added to the cart.

We need to act on the cart event, as need to change the item quantity before \Drupal\commerce_cart\EventSubscriber\CartEventSubscriber can show a message to the user about adding the item to the cart.

Hierarchy

• class \Drupal\commerce_license\EventSubscriber\LicenseMultiplesCartEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

See also

\Drupal\commerce_license\LicenseOrderProcessorMultiples

1 string reference to 'LicenseMultiplesCartEventSubscriber'

commerce_license.services.yml in ./commerce_license.services.yml

commerce_license.services.yml

1 service uses LicenseMultiplesCartEventSubscriber

commerce_license.license_multiples_cart_event_subscriber in ./commerce_license.services.yml

Drupal\commerce_license\EventSubscriber\LicenseMultiplesCartEventSubscriber

File

src/EventSubscriber/LicenseMultiplesCartEventSubscriber.php, line 21

Namespace

Drupal\commerce_license\EventSubscriber

class LicenseMultiplesCartEventSubscriber implements EventSubscriberInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events = [
      // These need to run before \Drupal\commerce_cart\EventSubscriber\CartEventSubscriber
      // Also expects the patch at https://www.drupal.org/project/commerce/issues/2930979
      // so that CartEventSubscriber doesn't show its message when we prevent
      // an item from being added.
      CartEvents::CART_ENTITY_ADD => [
        'onCartEntityAdd',
        100,
      ],
      CartEvents::CART_ORDER_ITEM_UPDATE => [
        'onCartItemUpdate',
        100,
      ],
    ];
    return $events;
  }

  /**
   * Enforces the maximum count when a product is added to the cart.
   *
   * Note that this event is triggered when adding a product to the cart from
   * the add to cart form when an item for this product is already in the cart.
   * This is treated as an entity add, even though technically it's an order
   * item that is being updated.
   *
   * @param \Drupal\commerce_cart\Event\CartEntityAddEvent $event
   *   The cart event.
   */
  public function onCartEntityAdd(CartEntityAddEvent $event) {
    $order_item = $event
      ->getOrderItem();

    // Only act if the order item has a license reference field.
    if (!$order_item
      ->hasField('license')) {
      return;
    }

    // TODO: Allow license type plugins to respond here, as for types that
    // collect user data in the checkout form, the same product variation can
    // result in different licenses.
    // Only act if the order item quantity is greater than 1.
    if ($order_item
      ->getQuantity() == 1) {
      return;
    }

    // Force the quantity back to 1.
    $this
      ->forceOrderItemQuantity($order_item);
    \Drupal::messenger()
      ->addError(t('You may only have one of @product-label in <a href="@cart-url">your cart</a>.', [
      '@product-label' => $order_item
        ->getPurchasedEntity()
        ->label(),
      '@cart-url' => Url::fromRoute('commerce_cart.page')
        ->toString(),
    ]));
  }

  /**
   * Enforces the maximum count when an item is updated.
   *
   * @param \Drupal\commerce_cart\Event\CartOrderItemUpdateEvent $event
   *   The cart event.
   */
  public function onCartItemUpdate(CartOrderItemUpdateEvent $event) {
    $order_item = $event
      ->getOrderItem();

    // Only act if the order item has a license reference field.
    if (!$order_item
      ->hasField('license')) {
      return;
    }

    // TODO: Allow license type plugins to respond here, as for types that
    // collect user data in the checkout form, the same product variation can
    // result in different licenses.
    // Only act if the order item quantity is greater than 1.
    if ($order_item
      ->getQuantity() == 1) {
      return;
    }

    // Force the quantity back to 1.
    $this
      ->forceOrderItemQuantity($order_item);

    // Don't show a link to the cart as the user will typically be on the cart
    // page.
    \Drupal::messenger()
      ->addError(t('You may only have one of @product-label in your cart.', [
      '@product-label' => $order_item
        ->getPurchasedEntity()
        ->label(),
    ]));
  }

  /**
   * Forces the quantity of an order item to 1, and saves it.
   *
   * @param \Drupal\commerce_order\Entity\OrderItemInterface $order_item
   *   The order item.
   */
  protected function forceOrderItemQuantity(OrderItemInterface $order_item) {

    // Force the quantity back to 1.
    $order_item
      ->setQuantity(1);

    // Save the order item again.
    $order_item
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LicenseMultiplesCartEventSubscriber::forceOrderItemQuantity	protected	function	Forces the quantity of an order item to 1, and saves it.
LicenseMultiplesCartEventSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
LicenseMultiplesCartEventSubscriber::onCartEntityAdd	public	function	Enforces the maximum count when a product is added to the cart.
LicenseMultiplesCartEventSubscriber::onCartItemUpdate	public	function	Enforces the maximum count when an item is updated.