interface DigestManagerInterface in Message Digest 8

Declares an interface for managing message digests.

Hierarchy

• interface \Drupal\message_digest\DigestManagerInterface

1 file declares its use of DigestManagerInterface

MessageDigest.php in src/Plugin/QueueWorker/MessageDigest.php

File

src/DigestManagerInterface.php, line 8

Namespace

Drupal\message_digest

interface DigestManagerInterface {

  /**
   * Cleanup old messages from the message_digest table.
   *
   * @deprecated
   *   This method is deprecated and will be removed before Message Digest 8.2.0
   *   is released. Entries in the message_digest table are cleaned up
   *   automatically when messages or users are deleted so this is no longer
   *   needed.
   */
  public function cleanupOldMessages();

  /**
   * Processes digests waiting to be aggregated.
   *
   * These are queued for processing and sending individually.
   */
  public function processDigests();

  /**
   * Processes and sends an individual digest for a given user.
   *
   * @param int $account_id
   *   The recipient's account ID.
   * @param string $notifier_id
   *   The digest notifier plugin ID.
   * @param int $end_time
   *   The unix timestamp prior to which to aggregate digests.
   */
  public function processSingleUserDigest($account_id, $notifier_id, $end_time);

  /**
   * Returns the Digest notifier plugins.
   *
   * @return \Drupal\message_digest\Plugin\Notifier\DigestInterface[]
   *   An associative array of Digest notifier plugins, keyed by plugin ID.
   */
  public function getNotifiers();

}

Members

Name	Modifiers	Type	Description	Overrides
DigestManagerInterface::cleanupOldMessages Deprecated	public	function	Cleanup old messages from the message_digest table.	1
DigestManagerInterface::getNotifiers	public	function	Returns the Digest notifier plugins.	1
DigestManagerInterface::processDigests	public	function	Processes digests waiting to be aggregated.	1
DigestManagerInterface::processSingleUserDigest	public	function	Processes and sends an individual digest for a given user.	1