forked from snytkine/LampCMS
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Notification.php
221 lines (187 loc) · 5.59 KB
/
Notification.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
215
216
217
218
219
220
221
<?php
/**
*
* PHP 5.3 or better is required
*
* @package Global functions
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*
* @author Dmitri Snytkine <cms@lampcms.com>
* @copyright 2005-2011 (or current year) ExamNotes.net inc.
* @license http://www.gnu.org/licenses/gpl-3.0.txt The GNU General Public License (GPL) version 3
* @link http://cms.lampcms.com Lampcms.com project
* @version Release: @package_version@
*
*
*/
namespace Lampcms\Event;
/**
* A Notification object
*
* The Notification object can be easily
* subclassed and serves as a container
* for the information about the notification.
* It holds an object which is
* usually a reference to the object that posted the notification,
* a notification name used to identify
* the notification and some user
* information which can be anything you need.
*
* @category Event
* @package Event_Dispatcher2
* @author Dmitri Snytkine
* @author Bertrand Mansion <bmansion@mamasam.com>
* @author Stephan Schmidt <schst@php.net>
* @copyright 1997-2009 The PHP Group
* @license BSD License http://www.opensource.org/licenses/bsd-license.php
* @version SVN: <svn_id>
* @link http://pear.php.net/package/Event_Dispatcher2
* @filesource
*
*/
class Notification extends Dispatcher
{
/**
* Default state of the notification
*/
const DEFAULT_STATE = 0;
/**
* Notification has been cancelled
*/
const CANCELLED_STATE = 1;
/**
* name of the notofication
* @var string
*/
protected $notificationName;
/**
* object of interest
* (the sender of the notification, in most cases)
* @var object
*/
protected $notificationObject;
/**
* additional information about the notification
* @var mixed
*/
protected $notificationInfo = array();
/**
* state of the notification
*
* This may be:
* - self::DEFAULT_STATE
* - self::CANCELLED_STATE
*
* @var integer
*/
protected $notificationState = self::DEFAULT_STATE;
/**
* amount of observers that received this notification
* @var mixed
*/
protected $notificationCount = 0;
/**
* Constructor
*
* @param object $object The object of interest for the notification,
* usually is the posting object
* @param string $name Notification name
* @param array $info Free information array
*
* @return void
*/
public function __construct($object, $name, array $info = array()){
$this->notificationObject = $object;
$this->notificationName = $name;
$this->notificationInfo = $info;
}
/**
* For information purposed and for purposes on loggin, so
* you may add the class to log like $log($oEvent)
* where $oEvent is this object
*
* @return string with info about this object
*/
public function __toString(){
return 'Notification object. "Event notification name":'.$this->notificationName;
}
/**
* Returns the notification name
*
* @return string Notification name
*/
function getNotificationName(){
return $this->notificationName;
}
/**
* Returns the contained object
*
* @return object Contained object
*/
public function getNotificationObject(){
return $this->notificationObject;
}
/**
* Returns the user info array
*
* @return array user info
*/
public function getNotificationInfo(){
return $this->notificationInfo;
}
/**
* Increase the internal count
*
* @access public
* @return void
*/
public function increaseNotificationCount(){
++$this->notificationCount;
}
/**
* Get the number of posted notifications
* This info is usefull for testing and debuging
*
* @return int
*/
public function getNotificationCount(){
return $this->notificationCount;
}
/**
* Cancel the notification
*
* @return void
*/
public function cancelNotification(){
$this->notificationState = self::CANCELLED_STATE;
}
/**
* Checks whether the notification has been cancelled
*
* @return boolean
*/
public function isNotificationCancelled(){
return ($this->notificationState === self::CANCELLED_STATE);
}
}