You are here

Home » API reference » Commerce License 8.2 » LicenseExpire.php

class LicenseExpire in Commerce License 8.2

Provides the job type for expiring licenses.

Plugin annotation


@AdvancedQueueJobType(
  id = "commerce_license_expire",
  label = @Translation("Expire licenses"),
)

Hierarchy

Expanded class hierarchy of LicenseExpire

File

src/Plugin/AdvancedQueue/JobType/LicenseExpire.php, line 21

Namespace

Drupal\commerce_license\Plugin\AdvancedQueue\JobType
View source 
class LicenseExpire extends JobTypeBase implements ContainerFactoryPluginInterface {

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

  /**
   * Constructs a new LicenseExpire 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_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'));
  }

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

    /** @var \Drupal\commerce_license\Entity\License $license */
    $license = $license_storage
      ->load($license_id);
    if (!$license) {
      return JobResult::failure('License not found.');
    }
    if ($license
      ->getState()
      ->getId() != 'active') {
      return JobResult::failure('License is no longer active.');
    }
    try {

      // Set the license to expired. The plugin will take care of revoking it.
      $license->state = 'expired';
      $license
        ->save();
    } catch (Exception $exception) {
      return $result = JobResult::failure($exception
        ->getMessage());
    }

    // If the license was successfully expired, create and queue a job to send
    // a notification.
    // Use a different queue so a) they can be processed differently, and b)
    // so if the expiry queue is very full, it doesn't delay notifications.
    // We send the email from here rather than in the License entity, as if
    // something else chooses to expire a license (e.g. Commerce Recurring), it
    // may want to be in control of the messages it sends.
    $queue_storage = $this->entityTypeManager
      ->getStorage('advancedqueue_queue');

    /** @var \Drupal\advancedqueue\Entity\QueueInterface $queue */
    $queue = $queue_storage
      ->load('commerce_license_notify');
    $expire_notification_job = Job::create('commerce_license_expire_notify', [
      'license_id' => $license_id,
    ]);
    $queue
      ->enqueueJob($expire_notification_job);
    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
LicenseExpire::$entityTypeManager protected property The entity type manager.
LicenseExpire::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LicenseExpire::process public function Processes the given job. Overrides JobTypeInterface::process
LicenseExpire::__construct public function Constructs a new LicenseExpire object. Overrides PluginBase::__construct
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.
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.