class SendIssue in Simplenews 8

Sends a newsletter issue.

Plugin annotation

@Action(
  id = "simplenews_send_action",
  label = @Translation("Send newsletter issue"),
  type = "node"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\simplenews\Plugin\Action\SendIssue

File

src/Plugin/Action/SendIssue.php, line 18

Namespace

Drupal\simplenews\Plugin\Action

class SendIssue extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $nodes = array();
    $labels = array();
    foreach ($entities as $node) {
      if ($node->simplenews_issue->status != SIMPLENEWS_STATUS_SEND_NOT) {
        continue;
      }
      if (!$node
        ->isPublished()) {
        simplenews_issue_update_sent_status($node, SIMPLENEWS_COMMAND_SEND_PUBLISH);
        $this
          ->messenger()
          ->addMessage(t('Newsletter issue %title is unpublished and will be sent on publish.', array(
          '%title' => $node
            ->label(),
        )));
        continue;
      }
      \Drupal::service('simplenews.spool_storage')
        ->addFromEntity($node);
      $nodes[$node
        ->id()] = $node;
      $labels[$node
        ->id()] = $node
        ->label();
    }

    // If there were any newsletters sent, display a message.
    if (!empty($nodes)) {
      $conditions = array(
        'entity_id' => array_keys($nodes),
        'entity_type' => 'node',
      );

      // Attempt to send immediately, if configured to do so.
      if (\Drupal::service('simplenews.mailer')
        ->attemptImmediateSend($conditions)) {
        $this
          ->messenger()
          ->addMessage(t('Sent the following newsletter(s): %titles.', array(
          '%titles' => implode(', ', $labels),
        )));
        $status = SIMPLENEWS_STATUS_SEND_READY;
      }
      else {
        $this
          ->messenger()
          ->addMessage(t('The following newsletter(s) are now pending: %titles.', array(
          '%titles' => implode(', ', $labels),
        )));
        $status = SIMPLENEWS_STATUS_SEND_PENDING;
      }
      foreach ($nodes as $node) {
        simplenews_issue_update_sent_status($node, $status);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($node = NULL) {
    $this
      ->executeMultiple(array(
      $node,
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function access($node, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($node
      ->hasField('simplenews_issue') && $node->simplenews_issue->target_id != NULL) {
      return AccessResult::allowedIfHasPermission($account, 'administer newsletters')
        ->orIf(AccessResult::allowedIfHasPermission($account, 'send newsletter'));
    }
    return AccessResult::neutral();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
SendIssue::access	public	function	Checks object access. Overrides ActionInterface::access
SendIssue::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
SendIssue::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.