braintree_cashier-8.x-4.x-dev/src/Event/NewSubscriptionEvent.php

<?php

namespace Drupal\braintree_cashier\Event;

use Braintree\Subscription;
use Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlanInterface;
use Drupal\braintree_cashier\Entity\BraintreeCashierSubscriptionInterface;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Creates an Event when a new subscription is created after signup.
 */
class NewSubscriptionEvent extends Event {

  /**
   * The Braintree Subscription.
   *
   * @var \Braintree\Subscription
   */
  protected $braintreeSubscription;

  /**
   * The Billing Plan entity.
   *
   * @var \Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlan
   *   The billing plan entity.
   */
  protected $billingPlan;

  /**
   * The subscription entity created.
   *
   * @var \Drupal\braintree_cashier\Entity\BraintreeCashierSubscriptionInterface
   *   The subscription entity created.
   */
  protected $subscriptionEntity;

  /**
   * The form state.
   *
   * @var \Drupal\Core\Form\FormStateInterface
   */
  protected $formState;

  /**
   * NewSubscriptionEvent constructor.
   *
   * @param \Braintree\Subscription $braintree_subscription
   *   The Braintree subscription just created.
   * @param \Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlanInterface $billing_plan
   *   The billing plan entity used to crete the subscription.
   * @param \Drupal\braintree_cashier\Entity\BraintreeCashierSubscriptionInterface $subscription_entity
   *   The subscription entity created.
   */
  public function __construct(Subscription $braintree_subscription, BraintreeCashierBillingPlanInterface $billing_plan, BraintreeCashierSubscriptionInterface $subscription_entity, FormStateInterface $formState) {
    $this->braintreeSubscription = $braintree_subscription;
    $this->billingPlan = $billing_plan;
    $this->subscriptionEntity = $subscription_entity;
    $this->formState = $formState;
  }

  /**
   * Gets the Billing Plan entity.
   *
   * @return \Drupal\braintree_cashier\Entity\BraintreeCashierBillingPlan
   *   The billing plan entity.
   */
  public function getBillingPlan() {
    return $this->billingPlan;
  }

  /**
   * Gets the Braintree subscription.
   *
   * @return \Braintree\Subscription
   *   The Braintree subscription.
   */
  public function getBraintreeSubscription() {
    return $this->braintreeSubscription;
  }

  /**
   * Gets the subscription entity.
   *
   * @return \Drupal\braintree_cashier\Entity\BraintreeCashierSubscriptionInterface
   *   The subscription entity.
   */
  public function getSubscriptionEntity() {
    return $this->subscriptionEntity;
  }

  /**
   * Gets the Form State.
   *
   * @return \Drupal\Core\Form\FormStateInterface
   *   The form state.
   */
  public function getFormState() {
    return $this->formState;
  }

}