class Author in Workbench Email 8
Same name and namespace in other branches
- 2.x src/Plugin/RecipientType/Author.php \Drupal\workbench_email\Plugin\RecipientType\Author
Provides a recipient type of the content author.
Plugin annotation
@RecipientType(
id = "author",
title = @Translation("Author"),
description = @Translation("Send to entity author/owner."),
)
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\Author
- class \Drupal\workbench_email\Plugin\RecipientTypeBase implements RecipientTypeInterface uses PluginWithFormsTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of Author
File
- src/
Plugin/ RecipientType/ Author.php, line 19
Namespace
Drupal\workbench_email\Plugin\RecipientTypeView source
class Author extends RecipientTypeBase {
/**
* {@inheritdoc}
*/
public function prepareRecipients(ContentEntityInterface $entity, TemplateInterface $template) {
$recipients = [];
if ($this
->isEnabled() && $entity instanceof EntityOwnerInterface) {
if (!$entity
->getOwner()
->isAnonymous()) {
$recipients[] = $entity
->getOwner()
->getEmail();
}
}
return $recipients;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Author:: |
public | function |
Returns email address(s) matching this recipient type's configuration. Overrides RecipientTypeBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginWithFormsTrait:: |
public | function | ||
PluginWithFormsTrait:: |
public | function | ||
RecipientTypeBase:: |
public | property | The name of the provider that owns this recipient type. | |
RecipientTypeBase:: |
public | property | An associative array containing the configured settings of this recipient type. | |
RecipientTypeBase:: |
public | property | A Boolean indicating whether this recipient type is enabled. | |
RecipientTypeBase:: |
public | function |
Generates a recipient types's settings form. Overrides RecipientTypeInterface:: |
3 |
RecipientTypeBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
2 |
RecipientTypeBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
|
RecipientTypeBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
|
RecipientTypeBase:: |
public | function |
Returns the administrative description for this recipient type plugin. Overrides RecipientTypeInterface:: |
|
RecipientTypeBase:: |
public | function |
Returns the administrative label for this recipient type plugin. Overrides RecipientTypeInterface:: |
|
RecipientTypeBase:: |
public | function |
Checks status. Overrides RecipientTypeInterface:: |
|
RecipientTypeBase:: |
public | function |
Informs the plugin that a dependency of the recipient type will be deleted. Overrides RecipientTypeInterface:: |
2 |
RecipientTypeBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
|
RecipientTypeBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
3 |
RecipientTypeBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
|
RecipientTypeBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
2 |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |