abstract class RecipientHandlerSelectBase in Simplenews 8.2

Base for Recipient Handlers that access the database directly using Select.

Derivatives access the underlying database directly use a Select query. This is very fast, but won't work with custom storage and can lead to more complex queries.

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

File

src/Plugin/simplenews/RecipientHandler/RecipientHandlerSelectBase.php, line 12

Namespace

Drupal\simplenews\Plugin\simplenews\RecipientHandler

abstract class RecipientHandlerSelectBase extends RecipientHandlerBase {

  /**
   * {@inheritdoc}
   */
  public function addToSpool() {
    $entity_type = $this->issue
      ->getEntityTypeId();
    $query = $this
      ->buildRecipientQuery();
    $query
      ->addExpression("'{$entity_type}'", 'entity_type');
    $query
      ->addExpression($this->issue
      ->id(), 'entity_id');
    $query
      ->addExpression(SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED, 'status');
    $query
      ->addExpression(REQUEST_TIME, 'timestamp');
    $this->connection
      ->insert('simplenews_mail_spool')
      ->from($query)
      ->execute();
    return $query
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * {@inheritdoc}
   */
  protected function doCount() {
    return $this
      ->buildRecipientQuery()
      ->countQuery()
      ->execute()
      ->fetchField();
  }

  /**
   * Build the query that gets the list of recipients.
   *
   * @return \Drupal\Core\Database\Query\SelectInterface
   *   Query with the columns 'snid' and 'newsletter_id' for each recipient.
   */
  protected abstract function buildRecipientQuery();

}

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::$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
RecipientHandlerSelectBase::addToSpool	public	function	Adds a newsletter issue to the mail spool. Overrides RecipientHandlerInterface::addToSpool
RecipientHandlerSelectBase::buildRecipientQuery	abstract protected	function	Build the query that gets the list of recipients.	1
RecipientHandlerSelectBase::doCount	protected	function	Counts the number of recipients. Overrides RecipientHandlerBase::doCount
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.