interface OrderItemMatcherInterface in Commerce Core 8.2

Finds matching order items.

Used for combining order items in the add to cart process.

By default, takes into account the order item type, purchased entity ID, and any custom fields shown on the add to cart form.

For example, when a custom "engraving" field is shown on the add to cart form, two order items will be combined if they have the same engraving, type, purchased entity ID.

Hierarchy

• interface \Drupal\commerce_cart\OrderItemMatcherInterface

File

modules/cart/src/OrderItemMatcherInterface.php, line 19

Namespace

Drupal\commerce_cart

interface OrderItemMatcherInterface {

  /**
   * Finds the first matching order item for the given order item.
   *
   * @param \Drupal\commerce_order\Entity\OrderItemInterface $order_item
   *   The order item.
   * @param \Drupal\commerce_order\Entity\OrderItemInterface[] $order_items
   *   The order items to match against.
   *
   * @return \Drupal\commerce_order\Entity\OrderItemInterface|null
   *   A matching order item, or NULL if none was found.
   */
  public function match(OrderItemInterface $order_item, array $order_items);

  /**
   * Finds all matching order items for the given order item.
   *
   * @param \Drupal\commerce_order\Entity\OrderItemInterface $order_item
   *   The order item.
   * @param \Drupal\commerce_order\Entity\OrderItemInterface[] $order_items
   *   The order items to match against.
   *
   * @return \Drupal\commerce_order\Entity\OrderItemInterface[]
   *   The matching order items.
   */
  public function matchAll(OrderItemInterface $order_item, array $order_items);

}

Members

Name	Modifiers	Type	Description	Overrides
OrderItemMatcherInterface::match	public	function	Finds the first matching order item for the given order item.	1
OrderItemMatcherInterface::matchAll	public	function	Finds all matching order items for the given order item.	1