TrackCheckoutStepEvent.php in Commerce Google Tag Manager 8.2

Namespace

Drupal\commerce_google_tag_manager\Event

File

src/Event/TrackCheckoutStepEvent.php

<?php

namespace Drupal\commerce_google_tag_manager\Event;

use Drupal\commerce_order\Entity\OrderInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Event dispatched when a checkout step is tracked.
 *
 * Event listeners may use this event to track checkout options.
 */
class TrackCheckoutStepEvent extends Event {

  /**
   * The checkout step number.
   *
   * @var int
   */
  private $stepIndex;

  /**
   * The order entity.
   *
   * @var \Drupal\commerce_order\Entity\OrderInterface
   */
  private $order;

  /**
   * Constructs a TrackCheckoutStepEvent object.
   *
   * @param int $step_index
   *   The step index of the checkout step, starting at 1.
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The commerce order representing the current cart.
   */
  public function __construct($step_index, OrderInterface $order) {
    $this->stepIndex = $step_index;
    $this->order = $order;
  }

  /**
   * Get the step index.
   *
   * @return int
   *   The step number.
   */
  public function getStepIndex() {
    return $this->stepIndex;
  }

  /**
   * Get the Checkout current order.
   *
   * @return \Drupal\commerce_order\Entity\OrderInterface
   *   The order entity.
   */
  public function getOrder() {
    return $this->order;
  }

}

Classes

Name	Description
TrackCheckoutStepEvent	Event dispatched when a checkout step is tracked.