ShipmentItemListInterface.php in Commerce Shipping 8.2

Namespace

Drupal\commerce_shipping\Plugin\Field\FieldType

File

src/Plugin/Field/FieldType/ShipmentItemListInterface.php

<?php

namespace Drupal\commerce_shipping\Plugin\Field\FieldType;

use Drupal\commerce_shipping\ShipmentItem as ShipmentItemValue;
use Drupal\Core\Field\FieldItemListInterface;

/**
 * Represents a list of shipment item field values.
 */
interface ShipmentItemListInterface extends FieldItemListInterface {

  /**
   * Gets the shipment item value objects from the field list.
   *
   * @return \Drupal\commerce_shipping\ShipmentItem[]
   *   The shipment item value objects.
   */
  public function getShipmentItems();

  /**
   * Removes the matching shipment item value.
   *
   * @param \Drupal\commerce_shipping\ShipmentItem $shipment_item
   *   The shipment item.
   *
   * @return $this
   */
  public function removeShipmentItem(ShipmentItemValue $shipment_item);

}

Interfaces

Name	Description
ShipmentItemListInterface	Represents a list of shipment item field values.