class ActivityDigestWorker in Open Social 8.8

An activity send email worker.

@QueueWorker( id = "activity_digest_worker", title = @Translation("Process activity_digest_worker queue."), cron = {"time" = 60} )

This QueueWorker is responsible for sending emails from the queue

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\activity_send\Plugin\QueueWorker\ActivitySendWorkerBase
      • class \Drupal\activity_send_email\Plugin\QueueWorker\ActivityDigestWorker

File

modules/custom/activity_send/modules/activity_send_email/src/Plugin/QueueWorker/ActivityDigestWorker.php, line 24

Namespace

Drupal\activity_send_email\Plugin\QueueWorker

class ActivityDigestWorker extends ActivitySendWorkerBase {

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    if (!empty($data['uid']) && !empty($data['frequency']) && !empty($data['activities'])) {

      // Get target account.
      $target = User::load($data['uid']);

      // Make sure we have an actual user account to work with.
      if ($target instanceof User && $target
        ->isActive()) {
        $langcode = $target
          ->getPreferredLangcode();
        $digest_notifications = [
          '#theme' => 'digestmail',
        ];
        foreach ($data['activities'] as $activity_id) {
          $activity = Activity::load($activity_id);

          // Continue if we have text to send.
          if (isset($activity->field_activity_output_text)) {

            // Load the message.
            $message = Message::load($activity->field_activity_message->target_id);
            $body_text = EmailActivityDestination::getSendEmailOutputText($message, $langcode);
            if ($langcode && !empty($body_text)) {
              $digest_notifications['#notifications'][] = $body_text;
            }
          }
        }

        // If we have notification to send continue preparing the email.
        if (!empty($digest_notifications['#notifications'])) {
          $notification_count = count($digest_notifications['#notifications']);

          // Get the notification count for the email template.
          $digest_notifications['#notification_count'] = \Drupal::translation()
            ->formatPlural($notification_count, 'You have received <strong>:count</strong> notification', 'You have received <strong>:count</strong> notifications', [
            ':count' => $notification_count,
          ], [
            'langcode' => $langcode,
          ]);
          $emailfrequencymanager = \Drupal::service('plugin.manager.emailfrequency');

          /* @var \Drupal\activity_send_email\EmailFrequencyInterface $instance */
          $instance = $emailfrequencymanager
            ->createInstance($data['frequency']);

          // Translating frequency instance in the language of the user.
          // @codingStandardsIgnoreStart
          $frequency_translated = t($instance
            ->getName()
            ->getUntranslatedString(), [], [
            'langcode' => $langcode,
          ]);

          // @codingStandardsIgnoreEnd
          // Get the notification settings for the email template.
          $digest_notifications['#notification_settings'] = \Drupal::translation()
            ->formatPlural($notification_count, 'Based on your @settings, the notification above is sent to you as a <strong>:frequency mail</strong>', 'Based on your @settings, the notifications above are sent to you as a <strong>:frequency mail</strong>', [
            '@settings' => Link::fromTextAndUrl(t('email notification settings'), Url::fromRoute('entity.user.edit_form', [
              'user' => $target
                ->id(),
            ])
              ->setAbsolute())
              ->toString(),
            ':frequency' => $frequency_translated,
          ], [
            'langcode' => $langcode,
          ]);

          // Render the notifications using the digestmail.html.twig template.
          $params['body'] = \Drupal::service('renderer')
            ->renderRoot($digest_notifications);

          // Send the email.
          $mail_manager = \Drupal::service('plugin.manager.mail');
          $mail_manager
            ->mail('activity_send_email', 'activity_send_email', $target
            ->getEmail(), $langcode, $params, NULL, TRUE);
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActivityDigestWorker::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
ActivitySendWorkerBase::createQueueItem	protected	function	Create queue item.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92