You are here

AdjustmentItemListInterface.php in Commerce Core 8.2

File

modules/order/src/Plugin/Field/FieldType/AdjustmentItemListInterface.php
View source
<?php

namespace Drupal\commerce_order\Plugin\Field\FieldType;

use Drupal\commerce_order\Adjustment;
use Drupal\Core\Field\FieldItemListInterface;

/**
 * Represents a list of adjustment item field values.
 */
interface AdjustmentItemListInterface extends FieldItemListInterface {

  /**
   * Gets the adjustment value objects from the field list.
   *
   * @return \Drupal\commerce_order\Adjustment[]
   *   An array of adjustment value objects.
   */
  public function getAdjustments();

  /**
   * Removes the matching adjustment value.
   *
   * @param \Drupal\commerce_order\Adjustment $adjustment
   *   The adjustment.
   *
   * @return $this
   */
  public function removeAdjustment(Adjustment $adjustment);

}

Interfaces

Namesort descending Description
AdjustmentItemListInterface Represents a list of adjustment item field values.