interface MessengerInterface

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Messenger/MessengerInterface.php \Drupal\Core\Messenger\MessengerInterface
  2. 8.9.x core/lib/Drupal/Core/Messenger/MessengerInterface.php \Drupal\Core\Messenger\MessengerInterface
  3. 10 core/lib/Drupal/Core/Messenger/MessengerInterface.php \Drupal\Core\Messenger\MessengerInterface

Stores runtime messages sent out to individual users on the page.

An example for these messages is for example: "Content X got saved".

Hierarchy

Expanded class hierarchy of MessengerInterface

All classes that implement MessengerInterface

58 files declare their use of MessengerInterface
AjaxFormBlock.php in core/modules/system/tests/modules/ajax_forms_test/src/Plugin/Block/AjaxFormBlock.php
AreaDisplayLinkTest.php in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
BanAdminTest.php in core/modules/ban/tests/src/Unit/BanAdminTest.php
BigPipe.php in core/modules/big_pipe/src/Render/BigPipe.php
BlockListBuilder.php in core/modules/block/src/BlockListBuilder.php

... See full list

File

core/lib/Drupal/Core/Messenger/MessengerInterface.php, line 10

Namespace

Drupal\Core\Messenger
View on git.drupalcode.org
View source 
interface MessengerInterface {
  
  /**
   * A status message.
   */
  const TYPE_STATUS = 'status';
  
  /**
   * A warning.
   */
  const TYPE_WARNING = 'warning';
  
  /**
   * An error.
   */
  const TYPE_ERROR = 'error';
  
  /**
   * Adds a new message to the queue.
   *
   * The messages will be displayed in the order they got added later.
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $message
   *   The translated message to be displayed to the user. For consistency with
   *   other messages, it should begin with a capital letter and end with a
   *   period.
   * @param string $type
   *   (optional) The message's type. Either self::TYPE_STATUS,
   *   self::TYPE_WARNING, or self::TYPE_ERROR.
   * @param bool $repeat
   *   (optional) If this is FALSE and the message is already set, then the
   *   message won't be repeated. Defaults to FALSE.
   *
   * @return $this
   */
  public function addMessage($message, $type = self::TYPE_STATUS, $repeat = FALSE);
  
  /**
   * Adds a new status message to the queue.
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $message
   *   The translated message to be displayed to the user. For consistency with
   *   other messages, it should begin with a capital letter and end with a
   *   period.
   * @param bool $repeat
   *   (optional) If this is FALSE and the message is already set, then the
   *   message won't be repeated. Defaults to FALSE.
   *
   * @return $this
   */
  public function addStatus($message, $repeat = FALSE);
  
  /**
   * Adds a new error message to the queue.
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $message
   *   The translated message to be displayed to the user. For consistency with
   *   other messages, it should begin with a capital letter and end with a
   *   period.
   * @param bool $repeat
   *   (optional) If this is FALSE and the message is already set, then the
   *   message won't be repeated. Defaults to FALSE.
   *
   * @return $this
   */
  public function addError($message, $repeat = FALSE);
  
  /**
   * Adds a new warning message to the queue.
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $message
   *   The translated message to be displayed to the user. For consistency with
   *   other messages, it should begin with a capital letter and end with a
   *   period.
   * @param bool $repeat
   *   (optional) If this is FALSE and the message is already set, then the
   *   message won't be repeated. Defaults to FALSE.
   *
   * @return $this
   */
  public function addWarning($message, $repeat = FALSE);
  
  /**
   * Gets all messages.
   *
   * @return string[][]|\Drupal\Component\Render\MarkupInterface[][]
   *   Keys are message types and values are indexed arrays of messages. Message
   *   types are either self::TYPE_STATUS, self::TYPE_WARNING, or
   *   self::TYPE_ERROR.
   */
  public function all();
  
  /**
   * Gets all messages of a certain type.
   *
   * @param string $type
   *   The messages' type. Either self::TYPE_STATUS, self::TYPE_WARNING,
   *   or self::TYPE_ERROR.
   *
   * @return string[]|\Drupal\Component\Render\MarkupInterface[]
   *   The messages of given type.
   */
  public function messagesByType($type);
  
  /**
   * Deletes all messages.
   *
   * @return string[]|\Drupal\Component\Render\MarkupInterface[]
   *   The deleted messages.
   */
  public function deleteAll();
  
  /**
   * Deletes all messages of a certain type.
   *
   * @param string $type
   *   The messages' type. Either self::TYPE_STATUS, self::TYPE_WARNING, or
   *   self::TYPE_ERROR.
   *
   * @return string[]|\Drupal\Component\Render\MarkupInterface[]
   *   The deleted messages of given type.
   */
  public function deleteByType($type);

}

Members

Title Modifiers Object type Summary Overrides
MessengerInterface::addError public function Adds a new error message to the queue. 1
MessengerInterface::addMessage public function Adds a new message to the queue. 1
MessengerInterface::addStatus public function Adds a new status message to the queue. 1
MessengerInterface::addWarning public function Adds a new warning message to the queue. 1
MessengerInterface::all public function Gets all messages. 1
MessengerInterface::deleteAll public function Deletes all messages. 1
MessengerInterface::deleteByType public function Deletes all messages of a certain type. 1
MessengerInterface::messagesByType public function Gets all messages of a certain type. 1
MessengerInterface::TYPE_ERROR constant An error.
MessengerInterface::TYPE_STATUS constant A status message.
MessengerInterface::TYPE_WARNING constant A warning.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.