class RecurringOrderClose in Commerce Recurring Framework 8

Provides the job type for closing recurring orders.

Plugin annotation

@AdvancedQueueJobType(
  id = "commerce_recurring_order_close",
  label = @Translation("Close recurring order"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\advancedqueue\Plugin\AdvancedQueue\JobType\JobTypeBase implements JobTypeInterface
      • class \Drupal\commerce_recurring\Plugin\AdvancedQueue\JobType\RecurringJobTypeBase implements ContainerFactoryPluginInterface
        • class \Drupal\commerce_recurring\Plugin\AdvancedQueue\JobType\RecurringOrderClose

File

src/Plugin/AdvancedQueue/JobType/RecurringOrderClose.php, line 17

Namespace

Drupal\commerce_recurring\Plugin\AdvancedQueue\JobType

class RecurringOrderClose extends RecurringJobTypeBase {

  /**
   * {@inheritdoc}
   */
  public function process(Job $job) {
    $order_id = $job
      ->getPayload()['order_id'];
    $order_storage = $this->entityTypeManager
      ->getStorage('commerce_order');

    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
    $order = $order_storage
      ->load($order_id);
    if (!$order) {
      return JobResult::failure('Order not found.');
    }
    if ($order
      ->getState()
      ->getId() == 'canceled') {
      return JobResult::failure('Order has been canceled.');
    }
    try {
      $this->recurringOrderManager
        ->closeOrder($order);
    } catch (DeclineException $exception) {

      // Both hard and soft declines need to be retried.
      // In case of a soft decline, the retry might succeed in charging the
      // same payment method. In case of a hard decline, the customer
      // might have changed their payment method since the last attempt.
      return $this
        ->handleDecline($order, $exception, $job
        ->getNumRetries());
    } catch (\Exception $exception) {

      // If something more general goes wrong, we assume it's not possible
      // or desirable to retry.
      $this
        ->handleFailedOrder($order);

      // Rethrow the exception so that the queue processor can log the job's
      // failure with the exception's message.
      throw $exception;
    }
    return JobResult::success();
  }

}

Members

Name	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
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
RecurringOrderClose::process	public	function	Processes the given job. Overrides JobTypeInterface::process
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.