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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\View\Element;
use Magento\Framework\Message\MessageInterface;
/**
* Class Messages
*
* @api
* @since 100.0.2
*/
class Messages extends Template
{
/**
* Messages collection
*
* @var \Magento\Framework\Message\Collection
*/
protected $messages;
/**
* Store first level html tag name for messages html output
*
* @var string
*/
protected $firstLevelTagName = 'div';
/**
* Store second level html tag name for messages html output
*
* @var string
*/
protected $secondLevelTagName = 'div';
/**
* Store content wrapper html tag name for messages html output
*
* @var string
*/
protected $contentWrapTagName = 'div';
/**
* Storage for used types of message storages
*
* @var array
*/
protected $usedStorageTypes = [];
/**
* Grouped message types
*
* @var string[]
*/
protected $messageTypes = [
MessageInterface::TYPE_ERROR,
MessageInterface::TYPE_WARNING,
MessageInterface::TYPE_NOTICE,
MessageInterface::TYPE_SUCCESS,
];
/**
* Message singleton
*
* @var \Magento\Framework\Message\Factory
*/
protected $messageFactory;
/**
* Message model factory
*
* @var \Magento\Framework\Message\CollectionFactory
*/
protected $collectionFactory;
/**
* Message manager
*
* @var \Magento\Framework\Message\ManagerInterface
*/
protected $messageManager;
/**
* @var Message\InterpretationStrategyInterface
*/
private $interpretationStrategy;
/**
* Constructor
*
* @param Template\Context $context
* @param \Magento\Framework\Message\Factory $messageFactory
* @param \Magento\Framework\Message\CollectionFactory $collectionFactory
* @param \Magento\Framework\Message\ManagerInterface $messageManager
* @param Message\InterpretationStrategyInterface $interpretationStrategy
* @param array $data
*/
public function __construct(
Template\Context $context,
\Magento\Framework\Message\Factory $messageFactory,
\Magento\Framework\Message\CollectionFactory $collectionFactory,
\Magento\Framework\Message\ManagerInterface $messageManager,
Message\InterpretationStrategyInterface $interpretationStrategy,
array $data = []
) {
$this->messageFactory = $messageFactory;
$this->collectionFactory = $collectionFactory;
$this->messageManager = $messageManager;
parent::__construct($context, $data);
$this->interpretationStrategy = $interpretationStrategy;
}
/**
* Set messages collection
*
* @param \Magento\Framework\Message\Collection $messages
* @return $this
*/
public function setMessages(\Magento\Framework\Message\Collection $messages)
{
$this->messages = $messages;
return $this;
}
/**
* Add messages to display
*
* @param \Magento\Framework\Message\Collection $messages
* @return $this
*/
public function addMessages(\Magento\Framework\Message\Collection $messages)
{
foreach ($messages->getItems() as $message) {
$this->getMessageCollection()->addMessage($message);
}
return $this;
}
/**
* Retrieve messages collection
*
* @return \Magento\Framework\Message\Collection
*/
public function getMessageCollection()
{
if (!$this->messages instanceof \Magento\Framework\Message\Collection) {
$this->messages = $this->collectionFactory->create();
}
return $this->messages;
}
/**
* Adding new message to message collection
*
* @param MessageInterface $message
* @return $this
*/
public function addMessage(MessageInterface $message)
{
$this->getMessageCollection()->addMessage($message);
return $this;
}
/**
* Adding new error message
*
* @param string $message
* @return $this
*/
public function addError($message)
{
$this->addMessage($this->messageFactory->create(MessageInterface::TYPE_ERROR, $message));
return $this;
}
/**
* Adding new warning message
*
* @param string $message
* @return $this
*/
public function addWarning($message)
{
$this->addMessage($this->messageFactory->create(MessageInterface::TYPE_WARNING, $message));
return $this;
}
/**
* Adding new notice message
*
* @param string $message
* @return $this
*/
public function addNotice($message)
{
$this->addMessage($this->messageFactory->create(MessageInterface::TYPE_NOTICE, $message));
return $this;
}
/**
* Adding new success message
*
* @param string $message
* @return $this
*/
public function addSuccess($message)
{
$this->addMessage($this->messageFactory->create(MessageInterface::TYPE_SUCCESS, $message));
return $this;
}
/**
* Retrieve messages array by message type
*
* @param string $type
* @return MessageInterface[]
*/
public function getMessagesByType($type)
{
return $this->getMessageCollection()->getItemsByType($type);
}
/**
* Return grouped message types
*
* @return array
*/
public function getMessageTypes()
{
return $this->messageTypes;
}
/**
* Retrieve messages in HTML format grouped by type
*
* @return string
*/
public function getGroupedHtml()
{
$html = $this->_renderMessagesByType();
$this->_dispatchRenderGroupedAfterEvent($html);
return $html;
}
/**
* Dispatch render after event
*
* @param null|string|array|\Magento\Framework\DataObject &$html
* @return void
*/
protected function _dispatchRenderGroupedAfterEvent(&$html)
{
$transport = new \Magento\Framework\DataObject(['output' => $html]);
$params = [
'element_name' => $this->getNameInLayout(),
'layout' => $this->getLayout(),
'transport' => $transport,
];
$this->_eventManager->dispatch('view_message_block_render_grouped_html_after', $params);
$html = $transport->getData('output');
}
/**
* Render messages in HTML format grouped by type
*
* @return string
*/
protected function _renderMessagesByType()
{
$html = '';
foreach ($this->getMessageTypes() as $type) {
if ($messages = $this->getMessagesByType($type)) {
if (!$html) {
$html .= '<' . $this->firstLevelTagName . ' class="messages">';
}
foreach ($messages as $message) {
$html .= '<' . $this->secondLevelTagName . ' class="message ' . 'message-' . $type . ' ' . $type .
'">';
$html .= '<' . $this->contentWrapTagName . $this->getUiId('message', $type) . '>';
$html .= $this->interpretationStrategy->interpret($message);
$html .= '</' . $this->contentWrapTagName . '>';
$html .= '</' . $this->secondLevelTagName . '>';
}
}
}
if ($html) {
$html .= '</' . $this->firstLevelTagName . '>';
}
return $html;
}
/**
* Render block HTML
*
* @return string
*/
protected function _toHtml()
{
if ($this->getTemplate()) {
$html = parent::_toHtml();
} else {
$html = $this->_renderMessagesByType();
}
return $html;
}
/**
* Set messages first level html tag name for output messages as html
*
* @param string $tagName
* @return void
*/
public function setFirstLevelTagName($tagName)
{
$this->firstLevelTagName = $tagName;
}
/**
* Set messages first level html tag name for output messages as html
*
* @param string $tagName
* @return void
*/
public function setSecondLevelTagName($tagName)
{
$this->secondLevelTagName = $tagName;
}
/**
* Get cache key informative items
*
* @return array
*/
public function getCacheKeyInfo()
{
return ['storage_types' => implode('|', $this->usedStorageTypes)];
}
/**
* Add used storage type
*
* @param string $type
* @return void
*/
public function addStorageType($type)
{
$this->usedStorageTypes[] = $type;
}
}