interface OrderShipmentSummaryInterface in Commerce Shipping 8.2

Provides a summary of an order's shipments.

Shown at checkout (review), admin/user order pages, order receipt emails.

Hierarchy

• interface \Drupal\commerce_shipping\OrderShipmentSummaryInterface

1 file declares its use of OrderShipmentSummaryInterface

ShippingInformation.php in src/Plugin/Commerce/CheckoutPane/ShippingInformation.php

File

src/OrderShipmentSummaryInterface.php, line 12

Namespace

Drupal\commerce_shipping

interface OrderShipmentSummaryInterface {

  /**
   * Builds a summary of the given order's shipments.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The order.
   * @param string $view_mode
   *   The view mode used to render the shipments.
   *
   * @return array
   *   The renderable array with the shipment summary.
   */
  public function build(OrderInterface $order, $view_mode = 'user');

}

Members

Name	Modifiers	Type	Description	Overrides
OrderShipmentSummaryInterface::build	public	function	Builds a summary of the given order's shipments.	1