class Cron in Commerce Recurring Framework 8

Default cron implementation.

Hierarchy

• class \Drupal\commerce_recurring\Cron implements CronInterface

1 string reference to 'Cron'

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

commerce_recurring.services.yml

1 service uses Cron

commerce_recurring.cron in ./commerce_recurring.services.yml

Drupal\commerce_recurring\Cron

File

src/Cron.php, line 13

Namespace

Drupal\commerce_recurring

class Cron implements CronInterface {

  /**
   * 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 Cron 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 function run() {
    $queue_storage = $this->entityTypeManager
      ->getStorage('advancedqueue_queue');

    /** @var \Drupal\advancedqueue\Entity\QueueInterface $recurring_queue */
    $recurring_queue = $queue_storage
      ->load('commerce_recurring');
    $this
      ->enqueueOrders($recurring_queue);
    $this
      ->enqueueSubscriptions($recurring_queue);
  }

  /**
   * Enqueues ended recurring orders for closing/renewal.
   *
   * @param \Drupal\advancedqueue\Entity\QueueInterface $recurring_queue
   *   The recurring queue.
   */
  protected function enqueueOrders(QueueInterface $recurring_queue) {
    $order_storage = $this->entityTypeManager
      ->getStorage('commerce_order');
    $order_ids = $order_storage
      ->getQuery()
      ->condition('type', 'recurring')
      ->condition('state', 'draft')
      ->condition('billing_period.ends', $this->time
      ->getRequestTime(), '<=')
      ->accessCheck(FALSE)
      ->execute();
    if (!$order_ids) {
      return;
    }

    /** @var \Drupal\commerce_order\Entity\OrderInterface[] $orders */
    $orders = $order_storage
      ->loadMultiple($order_ids);
    foreach ($orders as $order) {
      $subscriptions = $this->recurringOrderManager
        ->collectSubscriptions($order);
      if (!$subscriptions) {

        // The recurring order is malformed. The referenced subscription
        // might have been deleted manually.
        $order
          ->set('state', 'canceled');
        $order
          ->save();
        continue;
      }
      $subscription = reset($subscriptions);
      if ($subscription
        ->hasScheduledChanges()) {

        // Apply changes that were scheduled to happen on the next billing
        // cycle like suscription cancelation.
        $subscription
          ->applyScheduledChanges();
        $subscription
          ->save();
      }

      // If the subscription was scheduled for cancelation, applying the
      // scheduled changes has resulted in both the subscription and its
      // recurring order being canceled.
      // Canceled orders are considered closed, and don't need to be charged.
      if ($order
        ->getState()
        ->getId() == 'draft') {
        $close_job = Job::create('commerce_recurring_order_close', [
          'order_id' => $order
            ->id(),
        ]);
        $recurring_queue
          ->enqueueJob($close_job);
      }

      // Recurring orders are renewed only if their subscription is active.
      if ($subscription
        ->getState()
        ->getId() == 'active') {
        $renew_job = Job::create('commerce_recurring_order_renew', [
          'order_id' => $order
            ->id(),
        ]);
        $recurring_queue
          ->enqueueJob($renew_job);
      }
    }
  }

  /**
   * Enqueues pending and trial subscriptions for activation.
   *
   * @param \Drupal\advancedqueue\Entity\QueueInterface $recurring_queue
   *   The recurring queue.
   */
  protected function enqueueSubscriptions(QueueInterface $recurring_queue) {
    $subscription_storage = $this->entityTypeManager
      ->getStorage('commerce_subscription');
    $subscription_ids = $subscription_storage
      ->getQuery()
      ->condition('state', [
      'pending',
      'trial',
    ], 'IN')
      ->condition('starts', $this->time
      ->getRequestTime(), '<=')
      ->accessCheck(FALSE)
      ->execute();
    if (!$subscription_ids) {
      return;
    }
    foreach ($subscription_ids as $subscription_id) {
      $activate_job = Job::create('commerce_subscription_activate', [
        'subscription_id' => $subscription_id,
      ]);
      $recurring_queue
        ->enqueueJob($activate_job);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cron::$entityTypeManager	protected	property	The entity type manager.
Cron::$recurringOrderManager	protected	property	The recurring order manager.
Cron::$time	protected	property	The time.
Cron::enqueueOrders	protected	function	Enqueues ended recurring orders for closing/renewal.
Cron::enqueueSubscriptions	protected	function	Enqueues pending and trial subscriptions for activation.
Cron::run	public	function	Runs the cron. Overrides CronInterface::run
Cron::__construct	public	function	Constructs a new Cron object.