class OrderSubscriber in Commerce Recurring Framework 8

Hierarchy

• class \Drupal\commerce_recurring\EventSubscriber\OrderSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'OrderSubscriber'

commerce_recurring.services.yml in ./commerce_recurring.services.yml

commerce_recurring.services.yml

1 service uses OrderSubscriber

commerce_recurring.event_subscriber.order_subscriber in ./commerce_recurring.services.yml

Drupal\commerce_recurring\EventSubscriber\OrderSubscriber

File

src/EventSubscriber/OrderSubscriber.php, line 11

Namespace

Drupal\commerce_recurring\EventSubscriber

class OrderSubscriber implements EventSubscriberInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The recurring order manager.
   *
   * @var \Drupal\commerce_recurring\RecurringOrderManagerInterface
   */
  protected $recurringOrderManager;

  /**
   * The time.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs a new OrderSubscriber object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\commerce_recurring\RecurringOrderManagerInterface $recurring_order_manager
   *   The recurring order manager.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, RecurringOrderManagerInterface $recurring_order_manager, TimeInterface $time) {
    $this->entityTypeManager = $entity_type_manager;
    $this->recurringOrderManager = $recurring_order_manager;
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events['commerce_order.place.pre_transition'] = 'onPlace';
    $events['commerce_order.cancel.pre_transition'] = 'onCancel';
    return $events;
  }

  /**
   * Creates subscriptions when the initial order is placed.
   *
   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
   *   The transition event.
   */
  public function onPlace(WorkflowTransitionEvent $event) {

    /** @var \Drupal\commerce_recurring\SubscriptionStorageInterface $subscription_storage */
    $subscription_storage = $this->entityTypeManager
      ->getStorage('commerce_subscription');

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $event
      ->getEntity();
    if ($order
      ->bundle() == 'recurring') {
      return;
    }
    $payment_method = $order
      ->get('payment_method')->entity;
    $start_time = $this->time
      ->getRequestTime();
    foreach ($order
      ->getItems() as $order_item) {
      $purchased_entity = $order_item
        ->getPurchasedEntity();
      if (!$purchased_entity || !$purchased_entity
        ->hasField('subscription_type')) {
        continue;
      }
      $subscription_type_item = $purchased_entity
        ->get('subscription_type');
      $billing_schedule_item = $purchased_entity
        ->get('billing_schedule');
      if ($subscription_type_item
        ->isEmpty() || $billing_schedule_item
        ->isEmpty()) {
        continue;
      }

      /** @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface $billing_schedule */
      $billing_schedule = $billing_schedule_item->entity;

      // If the trial is not allowed and no payment method was collected, we
      // cannot proceed to the subscription creation.
      if (!$billing_schedule
        ->getPlugin()
        ->allowTrials() && empty($payment_method)) {
        continue;
      }
      $subscription = $subscription_storage
        ->createFromOrderItem($order_item, [
        'type' => $subscription_type_item->target_plugin_id,
        'billing_schedule' => $billing_schedule,
      ]);

      // Set the payment method if known, it's not required to start a free
      // trial if it wasn't collected.
      if (!empty($payment_method)) {
        $subscription
          ->setPaymentMethod($payment_method);
      }
      if ($billing_schedule
        ->getPlugin()
        ->allowTrials()) {
        $subscription
          ->setState('trial');
        $subscription
          ->setTrialStartTime($start_time);
        $subscription
          ->save();
        $this->recurringOrderManager
          ->startTrial($subscription);
      }
      else {
        $subscription
          ->setState('active');
        $subscription
          ->setStartTime($start_time);
        $subscription
          ->save();
        $this->recurringOrderManager
          ->startRecurring($subscription);
      }
    }
  }

  /**
   * Cancels subscriptions when the initial order is canceled.
   *
   * @param \Drupal\state_machine\Event\WorkflowTransitionEvent $event
   *   The transition event.
   */
  public function onCancel(WorkflowTransitionEvent $event) {

    /** @var \Drupal\commerce_recurring\SubscriptionStorageInterface $subscription_storage */
    $subscription_storage = $this->entityTypeManager
      ->getStorage('commerce_subscription');

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $event
      ->getEntity();
    if ($order
      ->bundle() == 'recurring') {
      return;
    }

    /** @var \Drupal\commerce_recurring\Entity\SubscriptionInterface[] $subscriptions */
    $query = $subscription_storage
      ->getQuery();
    $query
      ->condition('initial_order', $order
      ->id())
      ->condition('state', [
      'trial',
      'active',
    ], 'IN')
      ->accessCheck(FALSE);
    $result = $query
      ->execute();

    // No subscriptions were found, stop here.
    if (!$result) {
      return;
    }
    $subscriptions = $subscription_storage
      ->loadMultiple($result);
    foreach ($subscriptions as $subscription) {
      $subscription
        ->getState()
        ->applyTransitionById('cancel');
      $subscription
        ->save();
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
OrderSubscriber::$entityTypeManager	protected	property	The entity type manager.
OrderSubscriber::$recurringOrderManager	protected	property	The recurring order manager.
OrderSubscriber::$time	protected	property	The time.
OrderSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
OrderSubscriber::onCancel	public	function	Cancels subscriptions when the initial order is canceled.
OrderSubscriber::onPlace	public	function	Creates subscriptions when the initial order is placed.
OrderSubscriber::__construct	public	function	Constructs a new OrderSubscriber object.