1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Notification;
/**
* Class for processing the list of system messages
*
* Class MessageList
* @api
* @since 100.0.2
*/
class MessageList
{
/**
* List of configured message classes
*
* @var array
*/
protected $_messageClasses;
/**
* List of messages
*
* @var array
*/
protected $_messages;
/**
* @param \Magento\Framework\ObjectManagerInterface $objectManager
* @param array $messages
*/
public function __construct(\Magento\Framework\ObjectManagerInterface $objectManager, $messages = [])
{
$this->_objectManager = $objectManager;
$this->_messageClasses = $messages;
}
/**
* Load messages to display
*
* @return void
* @throws \InvalidArgumentException
* @throws \UnexpectedValueException
*/
protected function _loadMessages()
{
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.");
}
}
}
/**
* Retrieve message by
*
* @param string $identity
* @return null|\Magento\Framework\Notification\MessageInterface
*/
public function getMessageByIdentity($identity)
{
$this->_loadMessages();
return $this->_messages[$identity] ?? null;
}
/**
* Retrieve list of all messages
*
* @return \Magento\Framework\Notification\MessageInterface[]
*/
public function asArray()
{
$this->_loadMessages();
return $this->_messages;
}
}