interface RecipientHandlerInterface in Simplenews 8

Interface for Simplenews Recipient Handler Classes.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\simplenews\RecipientHandler\RecipientHandlerInterface extends \Drupal\simplenews\RecipientHandler\Countable

1 file declares its use of RecipientHandlerInterface

RecipientHandlerBase.php in src/Plugin/simplenews/RecipientHandler/RecipientHandlerBase.php

File

src/RecipientHandler/RecipientHandlerInterface.php, line 10

Namespace

Drupal\simplenews\RecipientHandler

interface RecipientHandlerInterface extends \Countable, PluginInspectionInterface {

  /**
   * Build the query that gets the list of recipients.
   *
   * @return A SelectQuery object with the columns 'snid', 'mail' and
   * 'newsletter_id' for each recipient.
   */
  function buildRecipientQuery();

  /**
   * Build a query to count the number of recipients.
   *
   * @return A SelectQuery object to count the number of recipients.
   */
  function buildRecipientCountQuery();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
RecipientHandlerInterface::buildRecipientCountQuery		function	Build a query to count the number of recipients.	1
RecipientHandlerInterface::buildRecipientQuery		function	Build the query that gets the list of recipients.	1