class OrderItemComparisonFieldsEvent in Commerce Core 8.2

Defines the order item comparison fields event.

Hierarchy

• class \Drupal\commerce\EventBase extends \Drupal\Component\EventDispatcher\Event
  • class \Drupal\commerce_cart\Event\OrderItemComparisonFieldsEvent

See also

\Drupal\commerce_cart\Event\CartEvents

1 file declares its use of OrderItemComparisonFieldsEvent

OrderItemMatcher.php in modules/cart/src/OrderItemMatcher.php

File

modules/cart/src/Event/OrderItemComparisonFieldsEvent.php, line 13

Namespace

Drupal\commerce_cart\Event

class OrderItemComparisonFieldsEvent extends EventBase {

  /**
   * The comparison fields.
   *
   * @var string[]
   */
  protected $comparisonFields;

  /**
   * The order item being added to the cart.
   *
   * @var \Drupal\commerce_order\Entity\OrderItemInterface
   */
  protected $orderItem;

  /**
   * Constructs a new OrderItemComparisonFieldsEvent.
   *
   * @param string[] $comparison_fields
   *   The comparison fields.
   * @param \Drupal\commerce_order\Entity\OrderItemInterface $order_item
   *   The order item being added to the cart.
   */
  public function __construct(array $comparison_fields, OrderItemInterface $order_item) {
    $this->comparisonFields = $comparison_fields;
    $this->orderItem = $order_item;
  }

  /**
   * Gets the comparison fields.
   *
   * @return string[]
   *   The comparison fields.
   */
  public function getComparisonFields() {
    return $this->comparisonFields;
  }

  /**
   * Sets the comparison fields.
   *
   * @param string[] $comparison_fields
   *   The comparison fields.
   */
  public function setComparisonFields(array $comparison_fields) {
    $this->comparisonFields = $comparison_fields;
  }

  /**
   * The order item being added to the cart.
   *
   * @return \Drupal\commerce_order\Entity\OrderItemInterface
   *   The order item being added to the cart.
   */
  public function getOrderItem() {
    return $this->orderItem;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OrderItemComparisonFieldsEvent::$comparisonFields	protected	property	The comparison fields.
OrderItemComparisonFieldsEvent::$orderItem	protected	property	The order item being added to the cart.
OrderItemComparisonFieldsEvent::getComparisonFields	public	function	Gets the comparison fields.
OrderItemComparisonFieldsEvent::getOrderItem	public	function	The order item being added to the cart.
OrderItemComparisonFieldsEvent::setComparisonFields	public	function	Sets the comparison fields.
OrderItemComparisonFieldsEvent::__construct	public	function	Constructs a new OrderItemComparisonFieldsEvent.