public function SpoolStorageInterface::getRecipientHandler in Simplenews 3.x

Same name and namespace in other branches

1. 8.2 src/Spool/SpoolStorageInterface.php \Drupal\simplenews\Spool\SpoolStorageInterface::getRecipientHandler()

Builds a recipient handler class for a given newsletter issue.

Parameters

\Drupal\Core\Entity\ContentEntityInterface $issue: The newsletter issue to be sent.

array $edited_values: (optional) Modified values, if called from an edit form.

bool $return_options: (optional, defaults to FALSE) If set, also return the set of valid options for choice of recipient handler.

Return value

\Drupal\simplenews\RecipientHandler\RecipientHandlerInterface|array A constructed recipient handler plugin. If $return_options is set then the return is an array of two items: the recipient handler plugin and the result of RecipientHandlerManager::getOptions().

Throws

\Exception If the handler class does not exist.

1 method overrides SpoolStorageInterface::getRecipientHandler()

SpoolStorage::getRecipientHandler in src/Spool/SpoolStorage.php

Builds a recipient handler class for a given newsletter issue.

File

src/Spool/SpoolStorageInterface.php, line 161

Class

SpoolStorageInterface

The spool storage manages a queue of mails that need to be sent.

Namespace

Drupal\simplenews\Spool

Code

public function getRecipientHandler(ContentEntityInterface $issue, array $edited_values = NULL, $return_options = FALSE);