class RecipientHandlerAll in Simplenews 8.2
Same name and namespace in other branches
- 3.x src/Plugin/simplenews/RecipientHandler/RecipientHandlerAll.php \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerAll
This handler sends a newsletter issue to all its subscribers.
As newsletters may have 100k subscribers, this class must be fast so extend from RecipientHandlerSelectBase.
Plugin annotation
@RecipientHandler(
id = "simplenews_all",
title = @Translation("All newsletter subscribers")
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerBase implements RecipientHandlerInterface
- class \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerSelectBase
- class \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerAll
- class \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerSelectBase
- class \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerBase implements RecipientHandlerInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of RecipientHandlerAll
File
- src/
Plugin/ simplenews/ RecipientHandler/ RecipientHandlerAll.php, line 18
Namespace
Drupal\simplenews\Plugin\simplenews\RecipientHandlerView source
class RecipientHandlerAll extends RecipientHandlerSelectBase {
/**
* {@inheritdoc}
*/
protected function buildRecipientQuery() {
$select = \Drupal::database()
->select('simplenews_subscriber', 's');
$select
->innerJoin('simplenews_subscriber__subscriptions', 't', 's.id = t.entity_id');
$select
->addField('s', 'id', 'snid');
$select
->addField('t', 'subscriptions_target_id', 'newsletter_id');
$select
->condition('t.subscriptions_target_id', $this
->getNewsletterId());
$select
->condition('t.subscriptions_status', SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED);
$select
->condition('s.status', SubscriberInterface::ACTIVE);
return $select;
}
/**
* {@inheritdoc}
*/
protected function cacheCount() {
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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. | |
RecipientHandlerAll:: |
protected | function |
Build the query that gets the list of recipients. Overrides RecipientHandlerSelectBase:: |
|
RecipientHandlerAll:: |
protected | function |
Checks if the recipient count can be cached. Overrides RecipientHandlerBase:: |
|
RecipientHandlerBase:: |
protected | property | The database connection. | |
RecipientHandlerBase:: |
protected | property | The newsletter issue. | |
RecipientHandlerBase:: |
protected | property | The newsletter IDs. | |
RecipientHandlerBase:: |
protected | function | Adds an array of entries to the spool. | |
RecipientHandlerBase:: |
public | function | ||
RecipientHandlerBase:: |
protected | function | Returns the newsletter ID. | |
RecipientHandlerBase:: |
public | function |
Returns the elements to add to the settings form for handler settings. Overrides RecipientHandlerInterface:: |
1 |
RecipientHandlerBase:: |
public | function |
RecipientHandlerBase constructor. Overrides PluginBase:: |
|
RecipientHandlerSelectBase:: |
public | function |
Adds a newsletter issue to the mail spool. Overrides RecipientHandlerInterface:: |
|
RecipientHandlerSelectBase:: |
protected | function |
Counts the number of recipients. Overrides RecipientHandlerBase:: |
|
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. |