DocumentSubscription.inc
8.58 KB
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
<?php
/**
*
* $Id$
*
* Represents a document subscription.
*
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
*
* @package lib.subscriptions
*/
class DocumentSubscription {
/**
* Primary key
*/
var $iID;
/**
* The ID of the document subscribed to
*/
var $iDocumentID;
/**
* The ID of the user subscribed to the document
*/
var $iUserID;
/**
* The time this subscription was triggered
*/
var $dTimeAlerted;
/**
* Whether this subscription is triggered
*/
var $bIsAlerted;
/**
* Creates a new document subscription object
*
* @param integer the document ID
* @param integer the user ID
*/
function DocumentSubscription($iDocumentID, $iUserID) {
//id of -1 means that the object has not yet been stored in the database
$this->iID = -1;
$this->iDocumentID = $iDocumentID;
$this->iUserID = $iUserID;
$this->dTimeAlerted = getCurrentDateTime();
$this->bIsAlerted = false;
}
/**
* Get the primary key of the current document subscription object
*
* @return integer primary key of document subscription
*/
function getID() {
return $this->iID;
}
/**
* Get the primary key of the document.
*
* @return integer primary key of document
*/
function getDocumentID() {
return $this->iDocumentID;
}
/**
* Set the document id
*
* @param integer new document primary key
*/
function setDocumentID($iNewValue) {
$this->iDocumentID = $iNewValue;
}
/**
* Get the primary key of the user
*
* @return integer primary key of user
*/
function getUserID() {
return $this->iUserID;
}
/**
* Set the user id
*
* @param integer new user primary key
*/
function setUserID($iNewValue) {
$this->iUserID = $iNewValue;
}
/**
* Get the time this document subscription was alerted
*
* @return string the date time the subscription alert was triggered
*/
function getTimeAlerted() {
return $this->dTimeAlerted;
}
/**
* Get the trigger status of this subscription
*
* @return boolean the trigger status of this subscription
*/
function getIsAlerted() {
return $this->bIsAlerted;
}
/**
* Set the trigger status of the subscription
*
* @param boolean new trigger status
*/
function setIsAlerted($iNewValue) {
$this->bIsAlerted = $iNewValue;
}
/**
* Create the current document subscription in the database
*
* @return boolean true and set $this->iID with new primary key, false otherwise and set $_SESSION["errorMessage"]
*/
function create() {
global $default, $lang_err_database;
$lang_err_object_exists;
//if the object has not already been stored
if ($this->iID < 0) {
$sql = $default->db;
if ($sql->query("INSERT INTO " . $default->owl_document_subscriptions_table . " (user_id, document_id) " .
"VALUES ($this->iUserID, $this->iDocumentID)")) {
$this->iID = $sql->insert_id();
return true;
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
} else {
$_SESSION["errorMessage"] = $lang_err_object_exists . "id = " . $this->iID . " table = document_subscriptions";
}
return false;
}
/**
* Update the current document subscription values in the database
*
* @return boolean true on successful update, false otherwise and set $_SESSION["errorMessage"]
*/
function update() {
global $default, $lang_err_database, $lang_err_object_key;
//can only update the object if it has already been stored
if ($this->iID >= 0) {
$sql = $default->db;
if ($sql->query("UPDATE " . $default->owl_document_subscriptions_table . " SET " .
"user_id = $this->iUserID, " .
"document_id = $this->iDocumentID " .
"datetime_alerted = '" . getCurrentDateTime() . "', " .
"is_alerted = $this->bIsAlerted " .
"WHERE id = " . $this->iID)) {
return true;
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
} else {
$_SESSION["errorMessage"] = $lang_err_object_key;
}
return false;
}
/**
* Delete the current object from the database
*
* @return boolean true and reset id to -1 on successful delete, false otherwise and set $_SESSION["errorMessage"]
*/
function delete() {
global $default, $lang_err_database, $lang_err_object_key;
if ($this->iID >= 0) {
$sql = $default->db;
if ($sql->query("DELETE FROM " . $default->owl_document_subscriptions_table . " WHERE id = " . $this->iID)) {
$this->iID = -1;
return true;
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
} else {
$_SESSION["errorMessage"] = $lang_err_object_key;
}
return false;
}
/**
* Static function.
* Given a document subscription primary key will create
* a document subscription object and populate it with the corresponding
* database values
*
* @param integer primary key of document subscription to get
*
* @return object document subscription object on successful retrieval, false otherwise and set $_SESSION["errorMessage"]
*/
function get($iDocumentSubscriptionID) {
global $default, $lang_err_object_not_exist, $lang_err_database;
$sql = $default->db;
if ($sql->query("SELECT * FROM " . $default->owl_document_subscriptions_table . " WHERE id = " . $iDocumentSubscriptionID)) {
if ($sql->next_record()) {
$oDocumentSubscription = & new DocumentSubscription($sql->f("document_id"), $sql->f("user_id"));
$oDocumentSubscription->iID = $iDocumentSubscriptionID;
return $oDocumentSubscription;
} else {
$_SESSION["errorMessage"] = $lang_err_object_not_exist . "id = " . $iDocumentSubscriptionID . " table = document_subscriptions";
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
return false;
}
/**
* Static function.
* Given a document subscription's values will create
* a document subscription object and populate it with the corresponding
* primary key
*
* @param integer the document ID
* @param integer the user ID
* @return object document subscription object on successful retrieval, false otherwise and set $_SESSION["errorMessage"]
*/
function getByIDs($iDocumentID, $iUserID) {
global $default, $lang_err_database, $lang_err_object_not_exist;
$sql = $default->db;
if ($sql->query("SELECT * FROM " . $default->owl_document_subscriptions_table . " " .
"WHERE document_id = $iDocumentID AND user_id = $iUserID")) {
if ($sql->next_record()) {
$oDocumentSubscription = & new DocumentSubscription($sql->f("document_id"), $sql->f("user_id"));
$oDocumentSubscription->iID = $sql->f("id");
return $oDocumentSubscription;
} else {
$_SESSION["errorMessage"] = $lang_err_object_not_exist . "id = " . $iDocumentSubscriptionID . " table = folder_subscriptions";
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
return false;
}
/**
* Checks if a given document subscription already exists using the document and user ids
*
* @param integer the document ID
* @param integer the user ID
* @return true if the document subscription exists, false otherwise
*/
function exists($iDocumentID, $iUserID) {
global $default, $lang_err_database;
$sql = $default->db;
if ($sql->query("SELECT id FROM " . $default->owl_document_subscriptions_table . " " .
"WHERE document_id = $iDocumentID AND user_id = $iUserID")) {
if ($sql->next_record()) {
return true;
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
}
return false;
}
}
?>