class RecipientHandler in Simplenews 8.2

Defines an recipient handler annotation object.

Plugin Namespace: Plugin\RecipientHandler.

For a working example, see \Drupal\simplenews\Plugin\simplenews\RecipientHandler\RecipientHandler

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\simplenews\RecipientHandler\Annotation\RecipientHandler

See also

\Drupal\simplenews\RecipientHandler\RecipientHandlerManager

\Drupal\simplenews\RecipientHandler\RecipientHandlerInterface

Plugin API

4 classes are annotated with RecipientHandler

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

This handler sends a newsletter issue to all its subscribers.

RecipientHandlerNewUsers in modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerNewUsers.php

This handler sends to all active users that have never logged in.

RecipientHandlerSiteMail in modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerSiteMail.php

Recipient Handler that sends to the main site mail.

RecipientHandlerSubscribersByRole in modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerSubscribersByRole.php

This handler sends to all subscribers with the specified role.

File

src/RecipientHandler/Annotation/RecipientHandler.php, line 21

Namespace

Drupal\simplenews\RecipientHandler\Annotation

class RecipientHandler extends Plugin {

  /**
   * The archiver plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the recipient handler plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * The description of the recipient handler plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2
RecipientHandler::$description	public	property	The description of the recipient handler plugin.
RecipientHandler::$id	public	property	The archiver plugin ID.
RecipientHandler::$title	public	property	The human-readable name of the recipient handler plugin.