class Digest in Message Digest 8

Defines a derived message digest plugin.

Plugin annotation

@Notifier(
  id = "message_digest",
  deriver = "\Drupal\message_digest\Plugin\Deriver\DigestDeriver",
  viewModes = {
    "mail_subject",
    "mail_body"
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\message_notify\Plugin\Notifier\MessageNotifierBase implements MessageNotifierInterface
    • class \Drupal\message_digest\Plugin\Notifier\DigestBase implements ContainerFactoryPluginInterface, DigestInterface
      • class \Drupal\message_digest\Plugin\Notifier\Digest

1 file declares its use of Digest

DigestTest.php in tests/src/Unit/Plugin/Notifier/DigestTest.php

File

src/Plugin/Notifier/Digest.php, line 17

Namespace

Drupal\message_digest\Plugin\Notifier

class Digest extends DigestBase {

}

Members

Name	Modifiers	Type	Description	Overrides
DigestBase::$connection	protected	property	Database connection.
DigestBase::$digestInterval	protected	property	The digest interval.
DigestBase::$state	protected	property	The state service for tracking last sent time.
DigestBase::$time	protected	property	The time service.
DigestBase::aggregate	public	function	Aggregate all of the messages for this digest. Overrides DigestInterface::aggregate
DigestBase::create	public static	function	Creates an instance of the plugin. Overrides MessageNotifierBase::create
DigestBase::deliver	public	function	Deliver a message via the required transport method. Overrides MessageNotifierInterface::deliver
DigestBase::getEndTime	public	function	Gets the end time for which to digest messages prior to. Overrides DigestInterface::getEndTime
DigestBase::getInterval	public	function	The interval to compile digests for. Overrides DigestInterface::getInterval
DigestBase::getRecipients	public	function	Get a unique list of recipient user IDs for this digest. Overrides DigestInterface::getRecipients
DigestBase::markSent	public	function	Mark the sent digest messages as sent in the message_digest DB table. Overrides DigestInterface::markSent
DigestBase::processDigest	public	function	Determine if it is time to process this digest or not. Overrides DigestInterface::processDigest
DigestBase::setLastSent	public	function	Sets the last sent time. Overrides DigestInterface::setLastSent
DigestBase::__construct	public	function	Constructs the digest notifier plugins. Overrides MessageNotifierBase::__construct
DigestBase::__sleep	public	function	Implements the magic __sleep() method.
DigestBase::__wakeup	public	function	Implements the magic __wakeup() method.
MessageNotifierBase::$entityTypeManager	protected	property	The entity type manager service.
MessageNotifierBase::$logger	protected	property	The logger channel.
MessageNotifierBase::$message	protected	property	The message entity.
MessageNotifierBase::$renderer	protected	property	The rendering service.
MessageNotifierBase::access	public	function	Determine if user can access notifier. Overrides MessageNotifierInterface::access
MessageNotifierBase::postSend	public	function	Save the rendered messages if needed. Invoke watchdog error on failure. Overrides MessageNotifierInterface::postSend
MessageNotifierBase::send	public	function	Entry point to send and process a message. Overrides MessageNotifierInterface::send
MessageNotifierBase::setMessage	public	function	Set the message object for the notifier. Overrides MessageNotifierInterface::setMessage
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.