class RecipientHandlerSubscribersByRole in Simplenews 3.x

This handler sends to all subscribers with the specified role.

Plugin annotation

@RecipientHandler(
  id = "simplenews_subscribers_by_role",
  title = @Translation("Subscribers by role")
)

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\RecipientHandlerEntityBase
        • class \Drupal\simplenews_demo\Plugin\simplenews\RecipientHandler\RecipientHandlerSubscribersByRole

File

modules/simplenews_demo/src/Plugin/simplenews/RecipientHandler/RecipientHandlerSubscribersByRole.php, line 16

Namespace

Drupal\simplenews_demo\Plugin\simplenews\RecipientHandler

class RecipientHandlerSubscribersByRole extends RecipientHandlerEntityBase {

  /**
   * {@inheritdoc}
   */
  public function settingsForm() {
    $roles = array_map([
      '\\Drupal\\Component\\Utility\\Html',
      'escape',
    ], user_role_names(TRUE));
    $element['role'] = [
      '#type' => 'select',
      '#title' => t('Role'),
      '#default_value' => $this->configuration['role'] ?? NULL,
      '#options' => $roles,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery() {
    return \Drupal::entityQuery('simplenews_subscriber')
      ->condition('status', SubscriberInterface::ACTIVE)
      ->condition('subscriptions', $this
      ->getNewsletterId())
      ->condition('subscriptions.status', SIMPLENEWS_SUBSCRIPTION_STATUS_SUBSCRIBED)
      ->condition('uid.entity.roles', $this->configuration['role']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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::__construct	public	function	RecipientHandlerBase constructor. Overrides PluginBase::__construct
RecipientHandlerEntityBase::addToSpool	public	function	Adds a newsletter issue to the mail spool. Overrides RecipientHandlerInterface::addToSpool
RecipientHandlerEntityBase::doCount	protected	function	Counts the number of recipients. Overrides RecipientHandlerBase::doCount
RecipientHandlerSubscribersByRole::buildEntityQuery	protected	function	Build the query that gets the list of subscribers. Overrides RecipientHandlerEntityBase::buildEntityQuery
RecipientHandlerSubscribersByRole::settingsForm	public	function	Returns the elements to add to the settings form for handler settings. Overrides RecipientHandlerBase::settingsForm
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.