class LastRevisionAuthor in Workbench Email 2.x

Defines a plugin for mailing to last revision author.

Plugin annotation

@RecipientType(
  id = "last_revision_author",
  title = @Translation("Last revision author"),
  description = @Translation("Send to previous revision author."),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\workbench_email\Plugin\RecipientTypeBase implements RecipientTypeInterface uses PluginWithFormsTrait
      • class \Drupal\workbench_email\Plugin\RecipientType\LastRevisionAuthor implements ContainerFactoryPluginInterface

File

src/Plugin/RecipientType/LastRevisionAuthor.php, line 22

Namespace

Drupal\workbench_email\Plugin\RecipientType

class LastRevisionAuthor extends RecipientTypeBase implements ContainerFactoryPluginInterface {

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = new static($configuration, $plugin_id, $plugin_definition);
    return $instance
      ->setEntityTypeManager($container
      ->get('entity_type.manager'));
  }

  /**
   * Sets entity type manager.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   Entity type manager.
   *
   * @return $this
   */
  protected function setEntityTypeManager(EntityTypeManagerInterface $entityTypeManager) {
    $this->entityTypeManager = $entityTypeManager;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRecipients(ContentEntityInterface $entity, TemplateInterface $template) {
    $entityStorage = $this->entityTypeManager
      ->getStorage($entity
      ->getEntityTypeId());
    $id_key = $entity
      ->getEntityType()
      ->getKey('id');
    if (!$id_key) {
      return [];
    }
    $revisions = $entityStorage
      ->getQuery()
      ->condition($id_key, $entity
      ->id())
      ->accessCheck(FALSE)
      ->allRevisions()
      ->execute();
    ksort($revisions);

    // Remove current revision.
    array_pop($revisions);
    $revision_ids = array_keys($revisions);
    $revision_id = array_pop($revision_ids);
    if ($revision_id && ($lastRevision = $entityStorage
      ->loadRevision($revision_id)) && $lastRevision instanceof RevisionLogInterface) {
      return [
        $lastRevision
          ->getRevisionUser()
          ->getEmail(),
      ];
    }
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
LastRevisionAuthor::$entityTypeManager	protected	property	Entity type manager.
LastRevisionAuthor::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
LastRevisionAuthor::prepareRecipients	public	function	Returns email address(s) matching this recipient type's configuration. Overrides RecipientTypeBase::prepareRecipients
LastRevisionAuthor::setEntityTypeManager	protected	function	Sets entity type manager.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	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.
PluginWithFormsTrait::getFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass	public	function	Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
RecipientTypeBase::$provider	public	property	The name of the provider that owns this recipient type.
RecipientTypeBase::$settings	public	property	An associative array containing the configured settings of this recipient type.
RecipientTypeBase::$status	public	property	A Boolean indicating whether this recipient type is enabled.
RecipientTypeBase::buildConfigurationForm	public	function	Generates a recipient types's settings form. Overrides RecipientTypeInterface::buildConfigurationForm	3
RecipientTypeBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	2
RecipientTypeBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
RecipientTypeBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
RecipientTypeBase::getDescription	public	function	Returns the administrative description for this recipient type plugin. Overrides RecipientTypeInterface::getDescription
RecipientTypeBase::getLabel	public	function	Returns the administrative label for this recipient type plugin. Overrides RecipientTypeInterface::getLabel
RecipientTypeBase::isEnabled	public	function	Checks status. Overrides RecipientTypeInterface::isEnabled
RecipientTypeBase::onDependencyRemoval	public	function	Informs the plugin that a dependency of the recipient type will be deleted. Overrides RecipientTypeInterface::onDependencyRemoval	2
RecipientTypeBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
RecipientTypeBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	3
RecipientTypeBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
RecipientTypeBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.