ktNavigationService.inc.php
8.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
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
<?php
/**
* Navigation Service CMIS wrapper API for KnowledgeTree.
*
* KnowledgeTree Community Edition
* Document Management Made Simple
* Copyright (C) 2008,2009 KnowledgeTree Inc.
* Portions copyright The Jam Warehouse Software (Pty) Limited
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* 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, see <http://www.gnu.org/licenses/>.
*
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
* California 94120-7775, or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
*
* @copyright 2008-2009, KnowledgeTree Inc.
* @license GNU General Public License version 3
* @author KnowledgeTree Team
* @package KTCMIS
* @version Version 0.9
*/
require_once(realpath(dirname(__FILE__) . '/ktService.inc.php'));
require_once(CMIS_DIR . '/services/CMISNavigationService.inc.php');
/*
* Handles repository navigation
*/
class KTNavigationService extends KTCMISBase {
protected $NavigationService;
public function __construct(&$ktapi = null, $username = null, $password = null)
{
parent::__construct($ktapi, $username, $password);
// instantiate underlying CMIS service
$this->NavigationService = new CMISNavigationService();
$this->setInterface();
}
public function startSession($username, $password)
{
parent::startSession($username, $password);
$this->setInterface();
return self::$session;
}
public function setInterface(&$ktapi = null)
{
parent::setInterface($ktapi);
$this->NavigationService->setInterface(self::$ktapi);
}
/**
* Get descendents of the specified folder, up to the depth indicated
*
* @param string $repositoryId
* @param string $folderId
* @param boolean $includeAllowableActions
* @param boolean $includeRelationships
* @param string $typeID
* @param int $depth
* @param string $filter
* @return array $descendants
*/
public function getDescendants($repositoryId, $folderId, $includeAllowableActions, $includeRelationships,
$depth = 1, $typeID = 'Any', $filter = '')
{
// TODO optional parameters
$descendantsResult = $this->NavigationService->getDescendants($repositoryId, $folderId, $includeAllowableActions,
$includeRelationships, $depth);
if (PEAR::isError($descendantsResult))
{
return array(
"status_code" => 1,
"message" => "Failed getting descendants for folder"
);
}
// format for webservices consumption
// NOTE this will almost definitely be changing in the future, this is just to get something working
$descendants = CMISUtil::decodeObjectHierarchy($descendantsResult, 'child');
return array (
"status_code" => 0,
"results" => $descendants
);
}
/**
* Get direct children of the specified folder
*
* @param string $repositoryId
* @param string $folderId
* @param boolean $includeAllowableActions
* @param boolean $includeRelationships
* @param string $typeID
* @param string $filter
* @param int $maxItems
* @param int $skipCount
* @return array $descendants
*/
public function getChildren($repositoryId, $folderId, $includeAllowableActions, $includeRelationships,
$typeID = 'Any', $filter = '', $maxItems = 0, $skipCount = 0)
{
// TODO paging
// TODO optional parameters
$childrenResult = $this->NavigationService->getChildren($repositoryId, $folderId, $includeAllowableActions, $includeRelationships);
if (PEAR::isError($childrenResult))
{
return array(
"status_code" => 1,
"message" => "Failed getting descendants for folder"
);
}
$children = CMISUtil::decodeObjectHierarchy($childrenResult, 'child');
return array(
"status_code" => 0,
"results" => $children
);
}
/**
* Gets the parent of the selected folder
*
* @param string $repositoryId
* @param string $folderId
* @param boolean $includeAllowableActions
* @param boolean $includeRelationships
* @param boolean $returnToRoot
* @param string $filter
* @return ancestry[]
*/
public function getFolderParent($repositoryId, $folderId, $includeAllowableActions, $includeRelationships, $returnToRoot, $filter = '')
{
try {
$ancestryResult = $this->NavigationService->getFolderParent($repositoryId, $folderId, $includeAllowableActions,
$includeRelationships, $returnToRoot);
}
catch (Exception $e) {
return array(
"status_code" => 1,
"message" => "Failed getting ancestry for folder: " . $e->getMessage()
);
}
if (PEAR::isError($ancestryResult))
{
return array(
"status_code" => 1,
"message" => "Failed getting ancestry for folder"
);
}
$ancestry = CMISUtil::decodeObjectHierarchy($ancestryResult, 'child');
return array(
"status_code" => 0,
"results" => $ancestry
);
}
/**
* Gets the parents for the selected object
*
* @param string $repositoryId
* @param string $folderId
* @param boolean $includeAllowableActions
* @param boolean $includeRelationships
* @param string $filter
* @return ancestry[]
*/
function getObjectParents($repositoryId, $objectId, $includeAllowableActions, $includeRelationships, $filter = '')
{
$ancestryResult = $this->NavigationService->getObjectParents($repositoryId, $objectId, $includeAllowableActions,
$includeRelationships);
if (PEAR::isError($ancestryResult))
{
return array(
"status_code" => 1,
"message" => "Failed getting ancestry for object"
);
}
$ancestry = CMISUtil::decodeObjectHierarchy($ancestryResult, 'child');
return array(
"status_code" => 0,
"results" => $ancestry
);
}
/**
* Returns a list of checked out documents from the selected repository
*
* @param string $repositoryId
* @param string $folderId The folder for which checked out docs are requested
* @param string $filter
* @param boolean $includeAllowableActions
* @param boolean $includeRelationships
* @param int $maxItems
* @param int $skipCount
* @return array $checkedout The collection of checked out documents
*/
function getCheckedOutDocs($repositoryId, $includeAllowableActions, $includeRelationships, $folderId = null, $filter = '',
$maxItems = 0, $skipCount = 0)
{
$checkedout = $this->NavigationService->getCheckedOutDocs($repositoryId, $includeAllowableActions, $includeRelationships,
$folderId, $filter, $maxItems, $skipCount);
if (PEAR::isError($checkedout))
{
return array(
"status_code" => 1,
"message" => "Failed getting list of checked out documents"
);
}
// convert to array format for external code
$co = array();
foreach ($checkedout as $documentProperties)
{
$co[] = CMISUtil::createObjectPropertiesEntry($documentProperties);;
}
return array(
"status_code" => 0,
"results" => $co
);
}
}
?>