You are here

interface RecipientHandlerInterface in Simplenews 3.x

Same name and namespace in other branches
  1. 8.2 src/RecipientHandler/RecipientHandlerInterface.php \Drupal\simplenews\RecipientHandler\RecipientHandlerInterface
  2. 8 src/RecipientHandler/RecipientHandlerInterface.php \Drupal\simplenews\RecipientHandler\RecipientHandlerInterface

Interface for Simplenews Recipient Handler Classes.

Hierarchy

Expanded class hierarchy of RecipientHandlerInterface

All classes that implement RecipientHandlerInterface

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
View source
interface RecipientHandlerInterface extends \Countable, PluginInspectionInterface {

  /**
   * Adds a newsletter issue to the mail spool.
   *
   * @return int
   *   Number of recipients added.
   */
  public function addToSpool();

  /**
   * Returns the elements to add to the settings form for handler settings.
   *
   * @return array
   *   The form elements.
   */
  public function settingsForm();

}

Members

Namesort descending 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::addToSpool public function Adds a newsletter issue to the mail spool. 3
RecipientHandlerInterface::settingsForm public function Returns the elements to add to the settings form for handler settings. 1