documentcore.inc.php
6.16 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
<?php
require_once(KT_LIB_DIR . '/ktentity.inc');
class KTDocumentCore extends KTEntity {
var $_bUsePearError = true;
/** The original creator of the document */
var $iCreatorId;
/** The creation time of the document */
var $dCreated;
/** The user that last modified the document */
var $iModifiedUserId;
/** The time of the last modification to the document */
var $dModified;
/** The parent folder of the document */
var $iFolderId;
/** List of folder from the root to the document */
var $sParentFolderIds;
/** Fully qualified path of the document */
var $sFullPath;
/** Status of the document (live, deleted, archived, &c.) */
var $iStatusId;
/** Where the document receives its permission information from */
var $iPermissionObjectId;
/** The fully looked-up permission information for this document */
var $iPermissionLookupId;
/** The most recent metadata version for the object */
var $iMetadataVersionId;
var $_aFieldToSelect = array(
"iId" => "id",
// transaction-related
"iCreatorId" => 'creator_id',
"dCreated" => 'created',
"iModifiedUserId" => 'modified_user_id',
"dModified" => 'modified',
// location-related
"iFolderId" => 'folder_id',
"sParentFolderIds" => 'parent_folder_ids',
"sFullPath" => 'full_path',
// status
"iStatusId" => 'status_id',
// permission-related
"iPermissionObjectId" => 'permission_object_id',
"iPermissionLookupId" => 'permission_lookup_id',
);
function KTDocument() {
}
// {{{ getters/setters
function getCreatorId() { return $this->iCreatorId; }
function setCreatorId($iNewValue) { $this->iCreatorId = $iNewValue; }
function getCreatedDateTime() { return $this->dCreated; }
function getModifiedUserId() { return $this->iModifiedUserId; }
function setModifiedUserId($iNewValue) { $this->iModifiedUserId = $iNewValue; }
function getLastModifiedDate() { return $this->dModified; }
function setLastModifiedDate($dNewValue) { $this->dModified = $dNewValue; }
function getFolderId() { return $this->iFolderId; }
function setFolderId($iNewValue) { $this->iFolderId = $iNewValue; }
function getStatusId() { return $this->iStatusId; }
function setStatusId($iNewValue) { $this->iStatusId = $iNewValue; }
function getPermissionObjectId() { return $this->iPermissionObjectId; }
function setPermissionObjectId($iNewValue) { $this->iPermissionObjectId = $iNewValue; }
function getPermissionLookupId() { return $this->iPermissionLookupId; }
function setPermissionLookupId($iNewValue) { $this->iPermissionLookupId = $iNewValue; }
// }}}
// {{{ getParentId
/**
* Allows documents to be treated like folders in terms of finding
* their parent objects.
*/
function getParentId() {
return $this->getFolderId();
}
// }}}
// {{{ ktentity requirements
function _fieldValues () {
$this->sFullPath = KTDocument::_generateFolderPath($this->iFolderId);
$this->sParentFolderIds = KTDocument::_generateFolderIds($this->iFolderId);
return parent::_fieldValues();
}
/**
* Recursive function to generate a comma delimited string containing
* the parent folder ids
*
* @return String comma delimited string containing the parent folder ids
*/
function _generateParentFolderIds($iFolderId) {
$sTable = KTUtil::getTableName('folders');
if (empty($iFolderId)) {
return;
}
$sQuery = sprintf('SELECT parent_id FROM %s WHERE id = ?', $sTable);
$aParams = array($iFolderId);
$iParentId = DBUtil::getOneResultKey(array($sQuery, $aParams), 'parent_id');
return Document::_generateParentFolderIds($iParentId) . ",$iFolderId";
}
/**
* Returns a comma delimited string containing the parent folder ids, strips leading /
*
* @return String comma delimited string containing the parent folder ids
*/
function _generateFolderIds($iFolderId) {
$sFolderIds = Document::_generateParentFolderIds($iFolderId);
return substr($sFolderIds, 1, strlen($sFolderIds));
}
/**
* Recursively generates forward slash deliminated string giving full path of document
* from file system root url
*/
function _generateFullFolderPath($iFolderId) {
global $default;
//if the folder is not the root folder
if (empty($iFolderId)) {
return;
}
$sQuery = sprintf("SELECT name, parent_id FROM %s WHERE Id = ?", $sTable);
$aParams = array($iFolderId);
$aRow = DBUtil::getOneResult(array($sQuery, $aParams));
return Document::_generateFullFolderPath($aRow["parent_id"]) . "/" . $aRow["name"];
}
/**
* Returns a forward slash deliminated string giving full path of document, strips leading /
*/
function _generateFolderPath($iFolderId) {
global $default;
$sPath = Document::_generateFullFolderPath($iFolderId);
$sPath = substr($sPath, 1, strlen($sPath));
return $sPath;
}
// }}}
// {{{ create
function create() {
if (empty($this->dCreated)) {
$this->dCreated = getCurrentDateTime();
}
if (empty($this->dModified)) {
$this->dModified = getCurrentDateTime();
}
if (empty($this->iModifiedUserId)) {
$this->iModifiedUserId = $this->iCreatorId;
}
$oFolder = Folder::get($this->getFolderId());
$this->iPermissionObjectId = $oFolder->getPermissionObjectId();
$res = parent::create();
if ($res === true) {
KTPermissionUtil::updatePermissionLookup($this);
}
return $res;
}
// }}}
// {{{ update
function update($bPathMove = false) {
$res = parent::update();
if (($res === true) && ($bPathMove === true)) {
KTPermissionUtil::updatePermissionLookup($this);
}
return $res;
}
// }}}
// {{{ get
function &get($iId) {
return KTEntityUtil::get('KTDocument', $iId);
}
// }}}
}
?>