class Immediately in Open Social 8.3

Define a concrete class for immediate emails.

Plugin annotation

@EmailFrequency(
  id = "immediately",
  name = @Translation("Immediately"),
  weight = 10,
  interval = 0
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\activity_send_email\EmailFrequencyBase implements EmailFrequencyInterface
    • class \Drupal\activity_send_email\Plugin\EmailFrequency\Immediately

File

modules/custom/activity_send/modules/activity_send_email/src/Plugin/EmailFrequency/Immediately.php, line 23

Namespace

Drupal\activity_send_email\Plugin\EmailFrequency

class Immediately extends EmailFrequencyBase {

  /**
   * {@inheritdoc}
   */
  public function processItem(Activity $activity, Message $message, User $target) {
    if ($target
      ->isBlocked()) {
      return;
    }

    // Continue if we have text to send and the user is currently offline.
    if (isset($activity->field_activity_output_text) && EmailActivityDestination::isUserOffline($target)) {
      $langcode = $target
        ->getPreferredLangcode();
      $body_text = EmailActivityDestination::getSendEmailOutputText($message, $langcode);
      if ($langcode && !empty($body_text)) {
        $this
          ->sendEmail($body_text, $langcode, $target);
      }
    }
  }

  /**
   * Send an email with a single notification.
   *
   * @param string $body_text
   *   The text to send to the target user.
   * @param string $langcode
   *   The langcode of the target user.
   * @param \Drupal\user\Entity\User $target
   *   The target account to send the email to.
   */
  protected function sendEmail($body_text, $langcode, User $target) {

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

    // @codingStandardsIgnoreEnd
    // Construct the render array.
    $notification = [
      '#theme' => 'directmail',
      '#notification' => $body_text,
      '#notification_settings' => t('Based on your @settings, the notification above is sent to you <strong>:frequency</strong>', [
        '@settings' => Link::fromTextAndUrl(t('email notification settings', [], [
          'langcode' => $langcode,
        ]), Url::fromRoute('entity.user.edit_form', [
          'user' => $target
            ->id(),
        ])
          ->setAbsolute())
          ->toString(),
        ':frequency' => $frequency_translated,
      ], [
        'langcode' => $langcode,
      ]),
    ];
    $params['body'] = \Drupal::service('renderer')
      ->renderRoot($notification);

    // 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
EmailFrequencyBase::getInterval	public	function	Return the interval of the email frequency in seconds. Overrides EmailFrequencyInterface::getInterval
EmailFrequencyBase::getName	public	function	Return the name of the email frequency. Overrides EmailFrequencyInterface::getName
EmailFrequencyBase::getWeight	public	function	Return the weight of the frequency option. Overrides EmailFrequencyInterface::getWeight
Immediately::processItem	public	function	Processes an activity item. Overrides EmailFrequencyBase::processItem
Immediately::sendEmail	protected	function	Send an email with a single notification.
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