SubscriptionManager.inc
4.75 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
<?php
require_once("$default->fileSystemRoot/lib/subscriptions/Subscription.inc");
/**
*
* $Id$
*
* Facilitates adding and removing file and folder subscriptions.
*
* 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 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 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 removeSubscription($iUserID, $iExternalID, $iSubscriptionType ) {
global $lang_sub_not_exists;
if (Subscription::exists($iUserID, $iExternalID, $iSubscriptionType)) {
$oSubscription = Subscription::getByIDs($iUserID, $iExternalID, $iSubscriptionType);
if ($oSubscription->delete()) {
return true;
} else {
// error message set in Subscription::delete
return false;
}
} else {
$_SESSION["errorMessage"] = $lang_sub_not_exists;
return false;
}
}
/**
* 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("folders" => SubscriptionManager::retrieveSubscriptions($iUserID, SubscriptionConstants::subscriptionType("FolderSubscription")),
"documents" => SubscriptionManager::retrieveSubscriptions($iUserID, SubscriptionConstants::subscriptionType("DocumentSubscription")));
}
/**
* 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 retrieveSubscriptions($iUserID, $iSubscriptionType) {
global $default;
$sql = $default->db;
if ($sql->query("SELECT id FROM " . Subscription::getTableName($iSubscriptionType) . " " .
"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;
}
}
?>