interface CartProviderInterface in Commerce Core 8.2

Creates and loads carts for anonymous and authenticated users.

Hierarchy

• interface \Drupal\commerce_cart\CartProviderInterface

See also

\Drupal\commerce_cart\CartSessionInterface

8 files declare their use of CartProviderInterface

AddToCartForm.php in modules/cart/src/Form/AddToCartForm.php

CartBlock.php in modules/cart/src/Plugin/Block/CartBlock.php

CartCacheContext.php in modules/cart/src/Cache/Context/CartCacheContext.php

CartCacheContextTest.php in modules/cart/tests/src/Unit/CartCacheContextTest.php

CartController.php in modules/cart/src/Controller/CartController.php

... See full list

File

modules/cart/src/CartProviderInterface.php, line 14

Namespace

Drupal\commerce_cart

interface CartProviderInterface {

  /**
   * Creates a cart order for the given store and user.
   *
   * @param string $order_type
   *   The order type ID.
   * @param \Drupal\commerce_store\Entity\StoreInterface $store
   *   The store. If empty, the current store is assumed.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user. If empty, the current user is assumed.
   *
   * @return \Drupal\commerce_order\Entity\OrderInterface
   *   The created cart order.
   *
   * @throws \Drupal\commerce_cart\Exception\DuplicateCartException
   *   When a cart with the given criteria already exists.
   */
  public function createCart($order_type, StoreInterface $store = NULL, AccountInterface $account = NULL);

  /**
   * Finalizes the given cart order.
   *
   * Removes the cart flag from the order and saves it.
   * If the user is anonymous, moves the cart ID from the
   * active to the completed cart session.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $cart
   *   The cart order.
   * @param bool $save_cart
   *   Whether to immediately save the cart or not.
   */
  public function finalizeCart(OrderInterface $cart, $save_cart = TRUE);

  /**
   * Gets the cart order for the given store and user.
   *
   * @param string $order_type
   *   The order type ID.
   * @param \Drupal\commerce_store\Entity\StoreInterface $store
   *   The store. If omitted, the current store is assumed.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user. If omitted, the current user is assumed.
   *
   * @return \Drupal\commerce_order\Entity\OrderInterface|null
   *   The cart order, or NULL if none found.
   */
  public function getCart($order_type, StoreInterface $store = NULL, AccountInterface $account = NULL);

  /**
   * Gets the cart order ID for the given store and user.
   *
   * @param string $order_type
   *   The order type ID.
   * @param \Drupal\commerce_store\Entity\StoreInterface|null $store
   *   The store. If omitted, the current store is assumed.
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   The user. If empty, the current user is assumed.
   *
   * @return int|null
   *   The cart order ID, or NULL if none found.
   */
  public function getCartId($order_type, StoreInterface $store = NULL, AccountInterface $account = NULL);

  /**
   * Gets all cart orders for the given user.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   The user. If omitted, the current user is assumed.
   * @param \Drupal\commerce_store\Entity\StoreInterface|null $store
   *   The store. If omitted, carts belonging to all stores are returned.
   *
   * @return \Drupal\commerce_order\Entity\OrderInterface[]
   *   A list of cart orders.
   */
  public function getCarts(AccountInterface $account = NULL, StoreInterface $store = NULL);

  /**
   * Gets all cart order ids for the given user.
   *
   * @param \Drupal\Core\Session\AccountInterface|null $account
   *   The user. If omitted, the current user is assumed.
   * @param \Drupal\commerce_store\Entity\StoreInterface|null $store
   *   The store. If omitted, carts belonging to all stores are returned.
   *
   * @return int[]
   *   A list of cart orders ids.
   */
  public function getCartIds(AccountInterface $account = NULL, StoreInterface $store = NULL);

  /**
   * Clears the static caches.
   */
  public function clearCaches();

}

Members

Name	Modifiers	Type	Description	Overrides
CartProviderInterface::clearCaches	public	function	Clears the static caches.	1
CartProviderInterface::createCart	public	function	Creates a cart order for the given store and user.	1
CartProviderInterface::finalizeCart	public	function	Finalizes the given cart order.	1
CartProviderInterface::getCart	public	function	Gets the cart order for the given store and user.	1
CartProviderInterface::getCartId	public	function	Gets the cart order ID for the given store and user.	1
CartProviderInterface::getCartIds	public	function	Gets all cart order ids for the given user.	1
CartProviderInterface::getCarts	public	function	Gets all cart orders for the given user.	1