You are here

Home » API reference » Commerce Recurring Framework 8 » RecurringJobTypeBase.php

abstract class RecurringJobTypeBase in Commerce Recurring Framework 8

Provides a base class for recurring job types.

Hierarchy

Expanded class hierarchy of RecurringJobTypeBase

File

src/Plugin/AdvancedQueue/JobType/RecurringJobTypeBase.php, line 20

Namespace

Drupal\commerce_recurring\Plugin\AdvancedQueue\JobType
View source 
abstract class RecurringJobTypeBase extends JobTypeBase implements ContainerFactoryPluginInterface {

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

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

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

  /**
   * Constructs a new RecurringJobTypeBase object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
   *   The event dispatcher.
   * @param \Drupal\commerce_recurring\RecurringOrderManagerInterface $recurring_order_manager
   *   The recurring order manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EventDispatcherInterface $event_dispatcher, RecurringOrderManagerInterface $recurring_order_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->eventDispatcher = $event_dispatcher;
    $this->recurringOrderManager = $recurring_order_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('event_dispatcher'), $container
      ->get('commerce_recurring.order_manager'));
  }

  /**
   * Handles a declined order payment.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The order.
   * @param \Drupal\commerce_payment\Exception\DeclineException $exception
   *   The decline exception.
   * @param int $num_retries
   *   The number of times the job was retried so far.
   *
   * @return \Drupal\advancedqueue\JobResult
   *   The job result.
   */
  protected function handleDecline(OrderInterface $order, DeclineException $exception, $num_retries) {

    /** @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface $billing_schedule */
    $billing_schedule = $order
      ->get('billing_schedule')->entity;
    $schedule = $billing_schedule
      ->getRetrySchedule();
    $max_retries = count($schedule);
    if ($num_retries < $max_retries) {
      $retry_days = $schedule[$num_retries];
      $result = JobResult::failure($exception
        ->getMessage(), $max_retries, 86400 * $retry_days);
    }
    else {
      $retry_days = 0;
      $result = JobResult::success('Dunning complete, recurring order not paid.');
      $this
        ->handleFailedOrder($order, FALSE);
    }

    // Subscribers can choose to send a dunning email.
    $event = new PaymentDeclinedEvent($order, $retry_days, $num_retries, $max_retries, $exception);
    $this->eventDispatcher
      ->dispatch(RecurringEvents::PAYMENT_DECLINED, $event);
    $order
      ->save();
    return $result;
  }

  /**
   * Handles an order whose payment has definitively failed.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The order.
   * @param bool $save_order
   *   Whether the order should be saved after the operation.
   */
  protected function handleFailedOrder(OrderInterface $order, $save_order = TRUE) {
    $order
      ->getState()
      ->applyTransitionById('mark_failed');

    /** @var \Drupal\commerce_recurring\Entity\BillingScheduleInterface $billing_schedule */
    $billing_schedule = $order
      ->get('billing_schedule')->entity;
    $unpaid_subscription_state = $billing_schedule
      ->getUnpaidSubscriptionState();
    if ($unpaid_subscription_state != 'active') {
      $this
        ->updateSubscriptions($order, $unpaid_subscription_state);
    }
    if ($save_order) {
      $order
        ->save();
    }
  }

  /**
   * Updates the recurring order's subscriptions to the new state.
   *
   * @param \Drupal\commerce_order\Entity\OrderInterface $order
   *   The recurring order.
   * @param string $new_state_id
   *   The new state.
   */
  protected function updateSubscriptions(OrderInterface $order, $new_state_id) {
    $subscriptions = $this->recurringOrderManager
      ->collectSubscriptions($order);
    foreach ($subscriptions as $subscription) {
      if ($subscription
        ->getState()
        ->getId() != 'active') {

        // The subscriptions are expected to be active, if one isn't, it
        // might have been canceled in the meantime.
        continue;
      }
      $subscription
        ->setState($new_state_id);
      $subscription
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
JobTypeBase::getLabel public function Gets the job type label. Overrides JobTypeInterface::getLabel
JobTypeBase::getMaxRetries public function Gets the maximum number of retries. Overrides JobTypeInterface::getMaxRetries
JobTypeBase::getRetryDelay public function Gets the retry delay. Overrides JobTypeInterface::getRetryDelay
JobTypeInterface::process public function Processes the given job. 4
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
RecurringJobTypeBase::$entityTypeManager protected property The entity type manager.
RecurringJobTypeBase::$eventDispatcher protected property The event dispatcher.
RecurringJobTypeBase::$recurringOrderManager protected property The recurring order manager.
RecurringJobTypeBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RecurringJobTypeBase::handleDecline protected function Handles a declined order payment.
RecurringJobTypeBase::handleFailedOrder protected function Handles an order whose payment has definitively failed.
RecurringJobTypeBase::updateSubscriptions protected function Updates the recurring order's subscriptions to the new state.
RecurringJobTypeBase::__construct public function Constructs a new RecurringJobTypeBase object. Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.