PaymentStatusSet.php in Payment 8.2

Namespace

Drupal\payment\Event

File

src/Event/PaymentStatusSet.php

<?php

namespace Drupal\payment\Event;

use Drupal\payment\Entity\PaymentInterface;
use Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Provides an event that is dispatched after a new status is set on a payment.
 *
 * @see \Drupal\payment\Event\PaymentEvents::PAYMENT_STATUS_SET
 */
class PaymentStatusSet extends Event {

  /**
   * The payment.
   *
   * @var \Drupal\payment\Entity\PaymentInterface
   */
  protected $payment;

  /**
   * The previous payment status.
   *
   * @var \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface|null
   */
  protected $previousPaymentStatus;

  /**-
   * Constructs a new instance.
   *
   * @param \Drupal\payment\Entity\PaymentInterface $payment
   *   The payment the status was set on.
   * @param \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface|null $previous_payment_status
   *   The payment's previous status or NULL if there is none.
   */
  public function __construct(PaymentInterface $payment, PaymentStatusInterface $previous_payment_status = NULL) {
    $this->payment = $payment;
    $this->previousPaymentStatus = $previous_payment_status;
  }

  /**
   * Gets the payment the status was set on.
   *
   * @return \Drupal\payment\Entity\PaymentInterface
   */
  public function getPayment() {
    return $this->payment;
  }

  /**
   * Gets the payment's previous status.
   *
   * @return \Drupal\payment\Plugin\Payment\Status\PaymentStatusInterface|null
   *   The previous status, or NULL of there is none.
   */
  public function getPreviousPaymentStatus() {
    return $this->previousPaymentStatus;
  }

}

Classes

Name	Description
PaymentStatusSet	Provides an event that is dispatched after a new status is set on a payment.