/
Inbox.php
214 lines (201 loc) · 6.25 KB
/
Inbox.php
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
<?php
/**
* Magento
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@magentocommerce.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade Magento to newer
* versions in the future. If you wish to customize Magento for your
* needs please refer to http://www.magentocommerce.com for more information.
*
* @copyright Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com)
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/
namespace Magento\AdminNotification\Model;
use \Magento\Framework\Notification\MessageInterface;
use \Magento\Framework\Notification\NotifierInterface;
/**
* AdminNotification Inbox model
*
* @method \Magento\AdminNotification\Model\Resource\Inbox _getResource()
* @method \Magento\AdminNotification\Model\Resource\Inbox getResource()
* @method int getSeverity()
* @method \Magento\AdminNotification\Model\Inbox setSeverity(int $value)
* @method string getDateAdded()
* @method \Magento\AdminNotification\Model\Inbox setDateAdded(string $value)
* @method string getTitle()
* @method \Magento\AdminNotification\Model\Inbox setTitle(string $value)
* @method string getDescription()
* @method \Magento\AdminNotification\Model\Inbox setDescription(string $value)
* @method string getUrl()
* @method \Magento\AdminNotification\Model\Inbox setUrl(string $value)
* @method int getIsRead()
* @method \Magento\AdminNotification\Model\Inbox setIsRead(int $value)
* @method int getIsRemove()
* @method \Magento\AdminNotification\Model\Inbox setIsRemove(int $value)
*
* @author Magento Core Team <core@magentocommerce.com>
*/
class Inbox extends \Magento\Framework\Model\AbstractModel implements NotifierInterface
{
/**
* @return void
*/
protected function _construct()
{
$this->_init('Magento\AdminNotification\Model\Resource\Inbox');
}
/**
* Retrieve Severity collection array
*
* @param int|null $severity
* @return array|string|null
*/
public function getSeverities($severity = null)
{
$severities = array(
MessageInterface::SEVERITY_CRITICAL => __('critical'),
MessageInterface::SEVERITY_MAJOR => __('major'),
MessageInterface::SEVERITY_MINOR => __('minor'),
MessageInterface::SEVERITY_NOTICE => __('notice')
);
if (!is_null($severity)) {
if (isset($severities[$severity])) {
return $severities[$severity];
}
return null;
}
return $severities;
}
/**
* Retrieve Latest Notice
*
* @return $this
*/
public function loadLatestNotice()
{
$this->setData(array());
$this->getResource()->loadLatestNotice($this);
return $this;
}
/**
* Retrieve notice statuses
*
* @return array
*/
public function getNoticeStatus()
{
return $this->getResource()->getNoticeStatus($this);
}
/**
* Parse and save new data
*
* @param array $data
* @return $this
*/
public function parse(array $data)
{
$this->getResource()->parse($this, $data);
return $this;
}
/**
* Add new message
*
* @param int $severity
* @param string $title
* @param string|string[] $description
* @param string $url
* @param bool $isInternal
* @throws \Magento\Framework\Model\Exception
* @return $this
*/
public function add($severity, $title, $description, $url = '', $isInternal = true)
{
if (!$this->getSeverities($severity)) {
throw new \Magento\Framework\Model\Exception(__('Wrong message type'));
}
if (is_array($description)) {
$description = '<ul><li>' . implode('</li><li>', $description) . '</li></ul>';
}
$date = date('Y-m-d H:i:s');
$this->parse(
array(
array(
'severity' => $severity,
'date_added' => $date,
'title' => $title,
'description' => $description,
'url' => $url,
'internal' => $isInternal
)
)
);
return $this;
}
/**
* Add critical severity message
*
* @param string $title
* @param string|string[] $description
* @param string $url
* @param bool $isInternal
* @return $this
*/
public function addCritical($title, $description, $url = '', $isInternal = true)
{
$this->add(MessageInterface::SEVERITY_CRITICAL, $title, $description, $url, $isInternal);
return $this;
}
/**
* Add major severity message
*
* @param string $title
* @param string|string[] $description
* @param string $url
* @param bool $isInternal
* @return $this
*/
public function addMajor($title, $description, $url = '', $isInternal = true)
{
$this->add(MessageInterface::SEVERITY_MAJOR, $title, $description, $url, $isInternal);
return $this;
}
/**
* Add minor severity message
*
* @param string $title
* @param string|string[] $description
* @param string $url
* @param bool $isInternal
* @return $this
*/
public function addMinor($title, $description, $url = '', $isInternal = true)
{
$this->add(MessageInterface::SEVERITY_MINOR, $title, $description, $url, $isInternal);
return $this;
}
/**
* Add notice
*
* @param string $title
* @param string|string[] $description
* @param string $url
* @param bool $isInternal
* @return $this
*/
public function addNotice($title, $description, $url = '', $isInternal = true)
{
$this->add(MessageInterface::SEVERITY_NOTICE, $title, $description, $url, $isInternal);
return $this;
}
}