DocumentTransaction.inc
7.03 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
<?php
DEFINE("CREATE", 1);
DEFINE("UPDATE", 2);
DEFINE("DELETE", 3);
DEFINE("RENAME", 4);
DEFINE("MOVE", 5);
DEFINE("DOWNLOAD", 6);
DEFINE("CHECKIN", 7);
DEFINE("CHECKOUT", 8);
DEFINE("COLLAB_ROLLBACK",9);
DEFINE("VIEW", 10);
DEFINE("EXPUNGE", 11);
DEFINE("FORCE_CHECKIN", 12);
DEFINE("EMAIL_LINK", 13);
DEFINE("COLLAB_ACCEPT", 14);
/**
* $Id$
*
* Represents a document transaction as per the database table document_transaction.
* No delete or update functions are provided. Once a transaction has been stored
* in the database it may not be changed.
*
* 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 Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.documentmanagement
*/
class DocumentTransaction {
/** primary key of document transaction */
var $iId;
/** primary key of document on which transaction occured */
var $iDocumentID;
/** version of document on which transaction occurs */
var $sVersion;
/** primary key of user who performed transaction */
var $iUserID;
/** time of transaction */
var $dDateTime;
/** IP address of computer that user was logged onto */
var $sIP;
/** path to documet on file system on which transaction was performed */
var $sFilename;
/** user comment associated with transaction */
var $sComment;
/** primary key of transaction type */
var $iTransactionID;
/**
* Constructor
*
* @param Primary key of document on which transaction was performed
* @param User comment associated with transaction
* @param Primary key of transaction type
*
*/
function DocumentTransaction($iNewDocumentID, $sNewComment, $iNewTransactionID) {
//object not stored yet, id = -1
$this->iId = -1;
$this->iDocumentID = $iNewDocumentID;
$this->sComment = $sNewComment;
$this->iTransactionID = $iNewTransactionID;
$oDocument = & Document::get($iNewDocumentID);
if ($oDocument) {
$this->sVersion = $oDocument->getMajorVersionNumber() . "." . $oDocument->getMinorVersionNumber();
$this->sFileName = Folder::getFolderPath($oDocument->getFolderID()) . "/" . $oDocument->getName();
}
$this->iUserID = $_SESSION["userID"];
$this->dDateTime = getCurrentDateTime();
$this->sIP = $_SERVER["REMOTE_ADDR"];
}
/**
* Returns the current version
*/
function getVersion() {
return $this->sVersion;
}
/**
* Create the document transaction in the database
*
* @return boolean true on successful creation, false otherwise and set $_SESSION["errorMessage"]
*
*/
function create() {
global $default, $lang_err_object_exists;
//if the object hasn't been stored yet
if ($this->iId < 0) {
$sql = $default->db;
$result = $sql->query("INSERT INTO " . $default->document_transactions_table . " (document_id, version, user_id, datetime, ip, filename, comment, transaction_id) " .
"VALUES ($this->iDocumentID, '" . addslashes($this->sVersion) . "', $this->iUserID, '" . addslashes($this->dDateTime) . "', '" . addslashes($this->sIP) . "', '" . addslashes($this->sFileName) . "', '" . addslashes($this->sComment) . "', $this->iTransactionID)");
if ($result) {
//object has been stored, set the primary key
$this->iId = $sql->insert_id();
return true;
} else {
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
} else {
$_SESSION["errorMessage"] = $lang_err_object_exists;
return false;
}
}
function delete() {
global $default, $lang_err_database, $lang_err_object_key;
if ($this->iId >= 0) {
$sql = $default->db;
$result = $sql->query("DELETE FROM " . $default->document_transactions_table . " WHERE id = " . $this->iId);
if ($result) {
$this->iId = -1;
return true;
}
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
$_SESSION["errorMessage"] = $lang_err_object_key;
return false;
}
/**
* Static function. Given a document transaction primary key will create
* a document transaction object and populate it with the corresponding
* database values
*
* @return DocumentTransaction populated DocumentTransaction object on success, false otherwise and set $_SESSION["errorMessage"]
*/
function & get($iDocumentTransactionID) {
global $default, $lang_err_doc_not_exist;
if (strlen($iDocumentTransactionID) > 0) {
$sql = $default->db;
$sql->query("SELECT * FROM $default->document_transactions_table WHERE id = $iDocumentTransactionID");
if ($sql->next_record()) {
$oDocumentTransaction = & new DocumentTransaction($sql->f("document_id"), stripslashes($sql->f("comment")), $sql->f("transaction_id"));
$oDocumentTransaction->iId = $sql->f("id");
$oDocumentTransaction->sVersion = $sql->f("version");
$oDocumentTransaction->iUserID = $sql->f("user_id");
$oDocumentTransaction->dDateTime = $sql->f("datetime");
$oDocumentTransaction->sIP = $sql->f("ip");
$oDocumentTransaction->sFileName = $sql->f("filename");
return $oDocumentTransaction;
}
$_SESSION["errorMessage"] = $lang_err_object_not_exist . "id = " . $iDocumentTransactionID . " table = document_transactions";
return false;
} else {
$_SESSION["errorMessage"] = "document transaction ID not set. Cannot retrieve document with no id";
return false;
}
}
/**
* Static function
* Get a list of DocumentTransactions
*
* @param String Where clause (not required)
*
* @return Array array of DocumentTransaction objects, false otherwise and set $_SESSION["errorMessage"]
*/
function getList($sWhereClause = null) {
global $default, $lang_err_database;
$aDocumentTransactionArray = array();
$sql = $default->db;
$sQuery = "SELECT * FROM $default->document_transactions_table " . (isset($sWhereClause) ? " WHERE " . $sWhereClause : "");
$result = $sql->query($sQuery);
if ($result) {
while ($sql->next_record()) {
$oDocumentTransaction = & DocumentTransaction::get($sql->f("id"));
$aDocumentTransactionArray[] = $oDocumentTransaction;
}
return $aDocumentTransactionArray;
}
$_SESSION["errorMessage"] = $lang_err_database;
return false;
}
}
?>