class Messenger in Open Social 10.3.x

Provide a Messenger service for use during demo content generation.

Mutes messages that we don't want users to see that can occur when social_demo creates demo content on the platform.

This class is intentionally broad and assumes the Social Demo module is disabled after creating demo content.

Hierarchy

• class \Drupal\Core\Messenger\Messenger implements MessengerInterface
  • class \Drupal\social_demo\Messenger

File

modules/custom/social_demo/src/Messenger.php, line 16

Namespace

Drupal\social_demo

class Messenger extends MessengerBase {

  /**
   * {@inheritdoc}
   */
  public function addMessage($message, $type = MessengerBase::TYPE_STATUS, $repeat = FALSE) {

    // Skip all status messages while the demo content module is enabled.
    // This avoids follow and enrollment messages that are not needed for the
    // admin. The demo content module provides its own way of showing progress
    // in drush.
    if ($type === MessengerBase::TYPE_STATUS) {
      return $this;
    }
    return MessengerBase::addMessage($message, $type, $repeat);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Messenger::$flashBag	protected	property	The flash bag.
Messenger::$killSwitch	protected	property	The kill switch.
Messenger::addError	public	function	Adds a new error message to the queue. Overrides MessengerInterface::addError
Messenger::addMessage	public	function	Adds a new message to the queue. Overrides Messenger::addMessage
Messenger::addStatus	public	function	Adds a new status message to the queue. Overrides MessengerInterface::addStatus
Messenger::addWarning	public	function	Adds a new warning message to the queue. Overrides MessengerInterface::addWarning
Messenger::all	public	function	Gets all messages. Overrides MessengerInterface::all
Messenger::deleteAll	public	function	Deletes all messages. Overrides MessengerInterface::deleteAll
Messenger::deleteByType	public	function	Deletes all messages of a certain type. Overrides MessengerInterface::deleteByType
Messenger::messagesByType	public	function	Gets all messages of a certain type. Overrides MessengerInterface::messagesByType
Messenger::__construct	public	function	Messenger constructor.
MessengerInterface::TYPE_ERROR		constant	An error.
MessengerInterface::TYPE_STATUS		constant	A status message.
MessengerInterface::TYPE_WARNING		constant	A warning.