You are here

abstract class RecipientHandlerEntityBase in Simplenews 3.x

Same name and namespace in other branches
  1. 8.2 src/Plugin/simplenews/RecipientHandler/RecipientHandlerEntityBase.php \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandlerEntityBase

Base for Recipient Handler classes based on EntityQuery.

Hierarchy

Expanded class hierarchy of RecipientHandlerEntityBase

2 files declare their use of RecipientHandlerEntityBase
RecipientHandlerNewUsers.php in modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerNewUsers.php
RecipientHandlerSubscribersByRole.php in modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerSubscribersByRole.php

File

src/Plugin/simplenews/RecipientHandler/RecipientHandlerEntityBase.php, line 8

Namespace

Drupal\simplenews\Plugin\simplenews\RecipientHandler
View source
abstract class RecipientHandlerEntityBase extends RecipientHandlerBase {

  /**
   * {@inheritdoc}
   */
  public function addToSpool() {
    $query = $this
      ->buildEntityQuery();
    $ids = $query
      ->execute();
    $field = $query
      ->getEntityTypeId() == 'user' ? 'uid' : 'snid';
    $this
      ->addArrayToSpool($field, $ids);
    return count($ids);
  }

  /**
   * {@inheritdoc}
   */
  protected function doCount() {
    return $this
      ->buildEntityQuery()
      ->count()
      ->execute();
  }

  /**
   * Build the query that gets the list of subscribers.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   Entity query on 'simplenews_subscriber' or 'user'.
   */
  protected abstract function buildEntityQuery();

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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.
RecipientHandlerBase::$connection protected property The database connection.
RecipientHandlerBase::$issue protected property The newsletter issue.
RecipientHandlerBase::$newsletterIds protected property The newsletter IDs.
RecipientHandlerBase::addArrayToSpool protected function Adds an array of entries to the spool.
RecipientHandlerBase::cacheCount protected function Checks if the recipient count can be cached. 2
RecipientHandlerBase::count public function
RecipientHandlerBase::getNewsletterId protected function Returns the newsletter ID.
RecipientHandlerBase::settingsForm public function Returns the elements to add to the settings form for handler settings. Overrides RecipientHandlerInterface::settingsForm 1
RecipientHandlerBase::__construct public function RecipientHandlerBase constructor. Overrides PluginBase::__construct
RecipientHandlerEntityBase::addToSpool public function Adds a newsletter issue to the mail spool. Overrides RecipientHandlerInterface::addToSpool
RecipientHandlerEntityBase::buildEntityQuery abstract protected function Build the query that gets the list of subscribers. 2
RecipientHandlerEntityBase::doCount protected function Counts the number of recipients. Overrides RecipientHandlerBase::doCount
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.