class WorkbenchEmailProcessor in Workbench Email 2.x

Sends emails notifications for workbench events.

Plugin annotation

@QueueWorker(
  id = "workbench_email_send",
  title = @Translation("Sends workbench email notifications"),
  cron = {"time" = 60},
  deriver = "\Drupal\workbench_email\Plugin\Derivative\WorkbenchEmailDeriver"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Queue\QueueWorkerBase implements QueueWorkerInterface
    • class \Drupal\workbench_email\Plugin\QueueWorker\WorkbenchEmailProcessor implements ContainerFactoryPluginInterface

File

src/Plugin/QueueWorker/WorkbenchEmailProcessor.php, line 26

Namespace

Drupal\workbench_email\Plugin\QueueWorker

class WorkbenchEmailProcessor extends QueueWorkerBase implements ContainerFactoryPluginInterface {

  /**
   * Entity type ID.
   *
   * @var string
   */
  protected $targetEntityType;

  /**
   * Mail manager service.
   *
   * @var \Drupal\Core\Mail\MailManager
   */
  protected $mailManager;

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

  /**
   * Token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

  /**
   * Entity repository service.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

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

  /**
   * Constructs a new WorkbenchEmailProcessor object.
   *
   * @param array $configuration
   *   Configuration.
   * @param string $plugin_id
   *   Plugin ID.
   * @param mixed $plugin_definition
   *   Definition.
   * @param \Drupal\Core\Mail\MailManagerInterface $mail_manager
   *   Mail manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   Entity repository service.
   * @param \Drupal\Core\Utility\Token $token
   *   Token service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   Renderer service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MailManagerInterface $mail_manager, EntityRepositoryInterface $entity_repository, Token $token, RendererInterface $renderer, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->mailManager = $mail_manager;
    $this->targetEntityType = $plugin_definition['entity_type'];
    $this->entityRepository = $entity_repository;
    $this->token = $token;
    $this->renderer = $renderer;
    $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('plugin.manager.mail'), $container
      ->get('entity.repository'), $container
      ->get('token'), $container
      ->get('renderer'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function processItem($data) {
    if ($data instanceof QueuedEmail) {
      $template = $data
        ->getTemplate();
      $uuid = $data
        ->getUuid();
      if ($entity = $this->entityRepository
        ->loadEntityByUuid($this->targetEntityType, $uuid)) {
        $body = $template
          ->getBody();

        /* @var \Drupal\Core\Entity\RevisionableStorageInterface $entity_storage */
        $entity_storage = $this->entityTypeManager
          ->getStorage($this->targetEntityType);
        $latest_revision_id = $entity_storage
          ->getLatestRevisionId($entity
          ->id());
        $entity = $entity_storage
          ->loadRevision($latest_revision_id);
        $subject = $this->token
          ->replace($template
          ->getSubject(), [
          $entity
            ->getEntityTypeId() => $entity,
        ], [
          'clear' => TRUE,
        ]);
        $body['value'] = $this->token
          ->replace($body['value'], [
          $entity
            ->getEntityTypeId() => $entity,
        ], [
          'clear' => TRUE,
        ]);
        $body = $this
          ->checkMarkup($body['value'], $body['format']);
        $replyTo = !empty($template
          ->getReplyTo()) ? $this->token
          ->replace($template
          ->getReplyTo(), [
          $entity
            ->getEntityTypeId() => $entity,
        ]) : NULL;

        // Send the email.
        $this->mailManager
          ->mail('workbench_email', 'template::' . $template
          ->id(), $data
          ->getTo(), LanguageInterface::LANGCODE_DEFAULT, [
          'body' => $body,
          'template' => $template,
          'subject' => $subject,
          'entity' => $entity,
        ], $replyTo);
      }
    }
    else {
      throw new \InvalidArgumentException('Cannot perform queue processing on objects other than a QueuedEmail.');
    }
  }

  /**
   * Converts message body to markup applying filter.
   *
   * @param string $text
   *   Text to filter.
   * @param string $format_id
   *   Format ID.
   * @param string $langcode
   *   Langcode.
   *
   * @return \Drupal\Component\Render\MarkupInterface
   *   Filtered markup.
   */
  protected function checkMarkup($text, $format_id, $langcode = LanguageInterface::LANGCODE_DEFAULT) {
    $build = [
      '#type' => 'processed_text',
      '#text' => $text,
      '#format' => $format_id,
      '#filter_types_to_skip' => [],
      '#langcode' => $langcode,
    ];
    return $this->renderer
      ->renderPlain($build);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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	2
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.
WorkbenchEmailProcessor::$entityRepository	protected	property	Entity repository service.
WorkbenchEmailProcessor::$entityTypeManager	protected	property	Entity type manager service.
WorkbenchEmailProcessor::$mailManager	protected	property	Mail manager service.
WorkbenchEmailProcessor::$renderer	protected	property	Renderer.
WorkbenchEmailProcessor::$targetEntityType	protected	property	Entity type ID.
WorkbenchEmailProcessor::$token	protected	property	Token service.
WorkbenchEmailProcessor::checkMarkup	protected	function	Converts message body to markup applying filter.
WorkbenchEmailProcessor::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
WorkbenchEmailProcessor::processItem	public	function	Works on a single queue item. Overrides QueueWorkerInterface::processItem
WorkbenchEmailProcessor::__construct	public	function	Constructs a new WorkbenchEmailProcessor object. Overrides PluginBase::__construct