You are here

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

class LicenseExpireNotify in Commerce License 8.2

Provides the job type to send an email notification of license expiry.

Plugin annotation


@AdvancedQueueJobType(
  id = "commerce_license_expire_notify",
  label = @Translation("Notify license owners of expiry"),
)

Hierarchy

Expanded class hierarchy of LicenseExpireNotify

File

src/Plugin/AdvancedQueue/JobType/LicenseExpireNotify.php, line 23

Namespace

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

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

  /**
   * The Renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The Mail Manager service.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $pluginManagerMail;

  /**
   * Creates a CommerceLicenseExpireNotify instance.
   *
   * @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 \Drupal\Core\Render\RendererInterface $renderer
   *   The Renderer service.
   * @param \Drupal\Core\Mail\MailManagerInterface $plugin_manager_mail
   *   The Mail Manager service.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer, MailManagerInterface $plugin_manager_mail) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
    $this->pluginManagerMail = $plugin_manager_mail;
  }

  /**
   * {@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('renderer'), $container
      ->get('plugin.manager.mail'));
  }

  /**
   * {@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.');
    }
    $owner = $license
      ->getOwner();
    if ($owner
      ->isAnonymous()) {
      return JobResult::failure('License owner not found.');
    }
    $to = $owner
      ->getEmail();

    // TODO: get the email address from the store that sold the product --
    // for which we'd a method on the license entity that queries for the
    // order item that refers to it.
    // this is quick temporary hack.
    $from = \Drupal::config('system.site')
      ->get('mail');
    $params = [
      'headers' => [
        'Content-Type' => 'text/html; charset=UTF-8;',
        'Content-Transfer-Encoding' => '8Bit',
      ],
      'from' => $from,
      'subject' => $this
        ->t('Your purchase of @license-label has now expired', [
        '@license-label' => $license
          ->label(),
      ]),
      'license' => $license,
    ];
    $build = [
      '#theme' => 'commerce_license_expire',
      '#license_entity' => $license,
    ];

    // Allow for the purchased entity to have been deleted.
    if ($purchased_entity = $license
      ->getPurchasedEntity()) {
      $build += [
        '#purchased_entity' => $purchased_entity,
        '#purchased_entity_url' => $purchased_entity
          ->toUrl()
          ->setAbsolute(),
      ];
    }
    $params['body'] = $this->renderer
      ->executeInRenderContext(new RenderContext(), function () use ($build) {
      return $this->renderer
        ->render($build);
    });
    $langcode = $owner
      ->getPreferredLangcode();
    $message = $this->pluginManagerMail
      ->mail('commerce_license', 'license_expire', $to, $langcode, $params);
    if ($message['result']) {
      return JobResult::success();
    }
    else {
      return JobResult::failure('Unable to send expiry notification mail.');
    }
  }

}

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
LicenseExpireNotify::$entityTypeManager protected property The entity type manager.
LicenseExpireNotify::$pluginManagerMail protected property The Mail Manager service.
LicenseExpireNotify::$renderer protected property The Renderer service.
LicenseExpireNotify::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LicenseExpireNotify::process public function Processes the given job. Overrides JobTypeInterface::process
LicenseExpireNotify::__construct public function Creates a CommerceLicenseExpireNotify instance. 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.