You are here

class RecurringOrderRenew in Commerce Recurring Framework 8

Provides the job type for renewing recurring orders.

Plugin annotation


@AdvancedQueueJobType(
  id = "commerce_recurring_order_renew",
  label = @Translation("Renew recurring order"),
)

Hierarchy

Expanded class hierarchy of RecurringOrderRenew

File

src/Plugin/AdvancedQueue/JobType/RecurringOrderRenew.php, line 16

Namespace

Drupal\commerce_recurring\Plugin\AdvancedQueue\JobType
View source
class RecurringOrderRenew 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.');
    }
    $this->recurringOrderManager
      ->renewOrder($order);
    return JobResult::success();
  }

}

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
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
RecurringOrderRenew::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.