1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Messenger
  7. \
  8. MessengerInterface

MessengerInterface

interface MessengerInterface (View source)

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

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

Constants

TYPE_STATUS

A status message.
TYPE_WARNING

A warning.
TYPE_ERROR

An error.

Methods

$this
addMessage(string|MarkupInterface $message, string $type = self::TYPE_STATUS, bool $repeat = FALSE)

Adds a new message to the queue.

$this
addStatus(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new status message to the queue.

$this
addError(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new error message to the queue.

$this
addWarning(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new warning message to the queue.

string[][]|MarkupInterface[][]
all()

Gets all messages.

string[]|MarkupInterface[]
messagesByType(string $type)

Gets all messages of a certain type.

string[]|MarkupInterface[]
deleteAll()

Deletes all messages.

string[]|MarkupInterface[]
deleteByType(string $type)

Deletes all messages of a certain type.

Details

at line 45
$this addMessage(string|MarkupInterface $message, string $type = self::TYPE_STATUS, bool $repeat = FALSE)

Adds a new message to the queue.

The messages will be displayed in the order they got added later.

Parameters

string|MarkupInterface $message

(optional) 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.
string $type

(optional) The message's type. Either self::TYPE_STATUS, self::TYPE_WARNING, or self::TYPE_ERROR.
bool $repeat

(optional) If this is FALSE and the message is already set, then the message won't be repeated. Defaults to FALSE.

Return Value

$this

at line 60
$this addStatus(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new status message to the queue.

Parameters

string|MarkupInterface $message

(optional) 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.
bool $repeat

(optional) If this is FALSE and the message is already set, then the message won't be repeated. Defaults to FALSE.

Return Value

$this

at line 75
$this addError(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new error message to the queue.

Parameters

string|MarkupInterface $message

(optional) 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.
bool $repeat

(optional) If this is FALSE and the message is already set, then the message won't be repeated. Defaults to FALSE.

Return Value

$this

at line 90
$this addWarning(string|MarkupInterface $message, bool $repeat = FALSE)

Adds a new warning message to the queue.

Parameters

string|MarkupInterface $message

(optional) 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.
bool $repeat

(optional) If this is FALSE and the message is already set, then the message won't be repeated. Defaults to FALSE.

Return Value

$this

at line 100
string[][]|MarkupInterface[][] all()

Gets all messages.

Return Value

string[][]|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.

at line 112
string[]|MarkupInterface[] messagesByType(string $type)

Gets all messages of a certain type.

Parameters

string $type

The messages' type. Either self::TYPE_STATUS, self::TYPE_WARNING, or self::TYPE_ERROR.

Return Value

string[]|MarkupInterface[]

The messages of given type.

at line 120
string[]|MarkupInterface[] deleteAll()

Deletes all messages.

Return Value

string[]|MarkupInterface[]

The deleted messages.

at line 132
string[]|MarkupInterface[] deleteByType(string $type)

Deletes all messages of a certain type.

Parameters

string $type

The messages' type. Either self::TYPE_STATUS, self::TYPE_WARNING, or self::TYPE_ERROR.

Return Value

string[]|MarkupInterface[]

The deleted messages of given type.