SubscriptionManager.inc
7.76 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
<?php
require_once(KT_LIB_DIR . "/subscriptions/Subscription.inc");
require_once(KT_LIB_DIR . "/subscriptions/subscriptions.inc.php");
/**
* $Id$
*
* Facilitates adding and removing file and folder subscriptions.
*
* Copyright (c) 2003 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Michael Joseph <michael@jamwarehouse.com>, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.subscriptions
*/
class SubscriptionManager {
/**
* Creates a subscription.
*
* @param int the user to create the subscription for
* @param int the external id to create the subscription for
* @param int the subscription type
* @return true if the subscription creation succeed, false and error message otherwise
*/
function createSubscription($iUserID, $iExternalID, $iSubscriptionType) {
global $lang_sub_exists;
if (!Subscription::exists($iUserID, $iExternalID, $iSubscriptionType)) {
$oSubscription = new Subscription($iUserID, $iExternalID, $iSubscriptionType);
if ($oSubscription->create()) {
return true;
} else {
// error message set in Subscription::create
return false;
}
} else {
// TODO: lookup username and folder name from ids for error message
$_SESSION["errorMessage"] = $lang_sub_exists . " type=$iSubscriptionType, ID=$iExternalID, userID=$iUserID";
return false;
}
}
/**
* Removes all subscriptions
*
* @param int the user to create the subscription for
* @param int the external id to create the subscription for
* @param int the subscription type
* @return true if the subscription creation succeed, false and error message otherwise
*/
function removeSubscriptions($iExternalID, $iSubscriptionType ) {
global $lang_sub_not_exists;
// first retrieve all the subscribers to this content
$aSubscriptions = SubscriptionManager::retrieveSubscriptions($iExternalID, $iSubscriptionType);
$bResult = true;
for ($i = 0; $i < count($aSubscriptions); $i++) {
// delete them
if ($aSubscriptions[$i]->delete()) {
$bResult = $bResult && true;
} else {
$bResult = $bResult && false;
}
}
return $bResult;
}
/**
* Retrieves all subscriptions for the specified content.
*
* @param int the external id to create the subscription for
* @param int the subscription type
*/
function retrieveSubscriptions($iExternalID, $iSubscriptionType) {
global $default;
$sql = $default->db;
if ($sql->query(array("SELECT id FROM " . Subscription::getTableName($iSubscriptionType) . " " ./*ok*/
"WHERE " . Subscription::getIdFieldName($iSubscriptionType) . " = ?", $iExternalID))) {
$aSubscriptions = array();
while ($sql->next_record()) {
$aSubscriptions[] = & Subscription::get($sql->f("id"), $iSubscriptionType);
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
return $aSubscriptions;
}
/**
* Clears the alert from the selected subscription and returns the
* path to the document.
*
* @param int the subscription ID to view
* @param int the subscription type
* @return string link to the subscription content, false if the operation failed
*/
function viewSubscription($iSubscriptionID, $iSubscriptionType) {
// instantiate subscription from id
$oSubscription = Subscription::get($iSubscriptionID, $iSubscriptionType);
if ($oSubscription) {
// update the alerted flag
$oSubscription->setIsAlerted(false);
// save the update
if ($oSubscription->update()) {
// return the url to the content
return $oSubscription->getContentUrl();
} else {
// error message set by Subscription::updates
return false;
}
} else {
// error message set by Subscription::get
return false;
}
}
/**
* Retrieves all subscriptions for this user.
*
* @param integer the ID of the user to retrieve subscriptions for
* @return array of subscription objects
*/
function listSubscriptions($iUserID) {
return $aSubscriptions = array_merge(SubscriptionManager::retrieveUserSubscriptions($iUserID, SubscriptionEvent::subTypes('Folder')),
SubscriptionManager::retrieveUserSubscriptions($iUserID, SubscriptionEvent::subTypes('Document')));
}
/**
* Retrieves the users's subscriptions
*
* @param integer the ID of the user to retrieve subscriptions for
* @return array of subscription objects, false if the database interaction fails
*/
function retrieveUserSubscriptions($iUserID, $iSubscriptionType) {
global $default;
$sql = $default->db;
if ($sql->query(array("SELECT id FROM " . Subscription::getTableName($iSubscriptionType) . " " ./*ok*/
"WHERE user_id = ?", $iUserID))) {
$aSubscriptions = array();
while ($sql->next_record()) {
$aSubscriptions[] = & Subscription::get($sql->f("id"), $iSubscriptionType);
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
return $aSubscriptions;
}
/**
* Retrieves all alerted subscriptions for this user.
*
* @param integer the ID of the user to retrieve alerted subscriptions for
* @return array of subscription objects
*/
function listSubscriptionAlerts($iUserID) {
return $aSubscriptions = array_merge(SubscriptionManager::retrieveSubscriptionAlerts($iUserID, SubscriptionEvent::subTypes("Folder")),
SubscriptionManager::retrieveSubscriptionAlerts($iUserID, SubscriptionEvent::subTypes("Document")));
}
/**
* Retrieves the users's subscriptions
*
* @param integer the ID of the user to retrieve subscriptions for
* @return array of subscription objects, false if the database interaction fails
*/
function retrieveSubscriptionAlerts($iUserID, $iSubscriptionType) {
global $default;
$sql = $default->db;
if ($sql->query(array("SELECT id FROM " . Subscription::getTableName($iSubscriptionType) . " " ./*ok*/
"WHERE user_id = ? " .
"AND is_alerted = ?", array($iUserID, true)))) {
$aSubscriptions = array();
while ($sql->next_record()) {
$aSubscriptions[] = & Subscription::get($sql->f("id"), $iSubscriptionType);
}
} else {
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
return $aSubscriptions;
}
}
?>