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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Message;
/**
* Represent a message with a type, content text, and an isSticky attribute to prevent message from being cleared.
*
* @api
* @since 100.0.2
*/
interface MessageInterface
{
/**
* Default identifier
*/
const DEFAULT_IDENTIFIER = 'default_message_identifier';
/**
* Error type
*/
const TYPE_ERROR = 'error';
/**
* Warning type
*/
const TYPE_WARNING = 'warning';
/**
* Notice type
*/
const TYPE_NOTICE = 'notice';
/**
* Success type
*/
const TYPE_SUCCESS = 'success';
/**
* Getter message type
*
* @return string
*/
public function getType();
/**
* Getter for text of message
*
* @return string
*/
public function getText();
/**
* Setter message text
*
* @param string $text
* @return $this
*/
public function setText($text);
/**
* Setter message identifier
*
* @param string $identifier
* @return $this
*/
public function setIdentifier($identifier);
/**
* Getter message identifier
*
* @return string
*/
public function getIdentifier();
/**
* Setter for flag. Whether message is sticky
*
* @param bool $isSticky
* @return $this
*/
public function setIsSticky($isSticky);
/**
* Getter for flag. Whether message is sticky
*
* @return bool
* @SuppressWarnings(PHPMD.BooleanGetMethodName)
*/
public function getIsSticky();
/**
* Retrieve message as a string
*
* @return string
*/
public function toString();
/**
* Sets message data
*
* @param array $data
* @return $this
* @throws \InvalidArgumentException
*/
public function setData(array $data = []);
/**
* Returns message data
*
* @return array
*/
public function getData();
}