class RecipientHandlerBase in Simplenews 8

Base class for all Recipient Handler classes.

This handler sends a newsletter issue to all subscribers of a given newsletter.

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

File

src/Plugin/simplenews/RecipientHandler/RecipientHandlerBase.php, line 20

Namespace

Drupal\simplenews\Plugin\simplenews\RecipientHandler

class RecipientHandlerBase extends PluginBase implements RecipientHandlerInterface {

  /**
   * The newsletter entity.
   *
   * @var SimplenewsNewsletter
   */
  public $newsletter;

  /**
   * @param SimplenewsNewsletter $newsletter
   *   The simplenews newsletter.
   * @param String $handler
   *   The name of the handler plugin to use.
   * @param array $settings
   *   An array of settings used by the handler to build the list of recipients.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->newsletter = $configuration['newsletter'];
  }

  /**
   * Implements SimplenewsRecipientHandlerInterface::buildRecipientQuery()
   */
  public 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('s', 'mail');
    $select
      ->addField('t', 'subscriptions_target_id', 'newsletter_id');
    $select
      ->condition('t.subscriptions_target_id', $this->newsletter
      ->id());
    $select
      ->condition('t.subscriptions_status', SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED);
    $select
      ->condition('s.status', SubscriberInterface::ACTIVE);
    return $select;
  }

  /**
   * Implements SimplenewsRecipientHandlerInterface::buildRecipientCountQuery()
   */
  public function buildRecipientCountQuery() {
    return $this
      ->buildRecipientQuery()
      ->countQuery();
  }

  /**
   * Implements Countable::count().
   */
  public function count() {
    return $this
      ->buildRecipientCountQuery()
      ->execute()
      ->fetchField();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	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.
RecipientHandlerBase::$newsletter	public	property	The newsletter entity.
RecipientHandlerBase::buildRecipientCountQuery	public	function	Implements SimplenewsRecipientHandlerInterface::buildRecipientCountQuery() Overrides RecipientHandlerInterface::buildRecipientCountQuery
RecipientHandlerBase::buildRecipientQuery	public	function	Implements SimplenewsRecipientHandlerInterface::buildRecipientQuery() Overrides RecipientHandlerInterface::buildRecipientQuery
RecipientHandlerBase::count	public	function	Implements Countable::count().
RecipientHandlerBase::__construct	public	function	Overrides PluginBase::__construct
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.