MessageList Class Reference

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $objectManager, $messages=[])
	getMessageByIdentity ($identity)
	asArray ()

Protected Member Functions
	_loadMessages ()

Protected Attributes
	$_messageClasses
	$_messages

Detailed Description

Class for processing the list of system messages

Class MessageList @api

Since

100.0.2

Definition at line 16 of file MessageList.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\ObjectManagerInterface	$objectManager,
			$messages = []
	)

Parameters

\Magento\Framework\ObjectManagerInterface	$objectManager
array	$messages

Definition at line 36 of file MessageList.php.

    {
        $this->_objectManager = $objectManager;
        $this->_messageClasses = $messages;
    }

Member Function Documentation

_loadMessages()

_loadMessages ( )

protected

Load messages to display

Returns

void

Exceptions

Definition at line 49 of file MessageList.php.

    {
        if (!empty($this->_messages)) {
            return;
        }
        foreach ($this->_messageClasses as $key => $messageClass) {
            if (!$messageClass) {
                throw new \InvalidArgumentException('Message class for message "' . $key . '" is not set');
            }
            $message = $this->_objectManager->get($messageClass);
            if ($message instanceof \Magento\Framework\Notification\MessageInterface) {
                $this->_messages[$message->getIdentity()] = $message;
            } else {
                throw new \UnexpectedValueException("Message class has to implement the message interface.");
            }
        }
    }

asArray()

asArray

(

)

Retrieve list of all messages

Returns

\Magento\Framework\Notification\MessageInterface[]

Definition at line 84 of file MessageList.php.

    {
        $this->_loadMessages();
        return $this->_messages;
    }

getMessageByIdentity()

getMessageByIdentity

(

$identity

)

Retrieve message by

Parameters

string

$identity

Returns

null|\Magento\Framework\Notification\MessageInterface

Definition at line 73 of file MessageList.php.

    {
        $this->_loadMessages();
        return $this->_messages[$identity] ?? null;
    }

Field Documentation

$_messageClasses

$_messageClasses

protected

Definition at line 23 of file MessageList.php.

$_messages

$_messages

protected

Definition at line 30 of file MessageList.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Notification/MessageList.php