Peter M. Groen / knowledgetree

Commit cbaf75bc09ab57b56e0956a27fe8f6fa07fdfb00

Authored by Paul Barrett
1 parent 552c8bfe

some minor documentation changes in cmis files

Inline Side-by-side
Showing 3 changed files with 27 additions and 37 deletions
ktcmis/ktcmis.inc.php
  View file @cbaf75b
... ... @@ -259,8 +259,8 @@ class KTCMIS {
259 259 *
260 260 * @param string $repositoryId
261 261 * @param string $folderId
262   - * @param bool $includeAllowableActions
263   - * @param bool $includeRelationships
  262 + * @param boolean $includeAllowableActions
  263 + * @param boolean $includeRelationships
264 264 * @param string $typeID
265 265 * @param int $depth
266 266 * @param string $filter
... ... @@ -301,8 +301,8 @@ class KTCMIS {
301 301 *
302 302 * @param string $repositoryId
303 303 * @param string $folderId
304   - * @param bool $includeAllowableActions
305   - * @param bool $includeRelationships
  304 + * @param boolean $includeAllowableActions
  305 + * @param boolean $includeRelationships
306 306 * @param string $typeID
307 307 * @param string $filter
308 308 * @param int $maxItems
... ... @@ -339,9 +339,9 @@ class KTCMIS {
339 339 *
340 340 * @param string $repositoryId
341 341 * @param string $folderId
342   - * @param bool $includeAllowableActions
343   - * @param bool $includeRelationships
344   - * @param bool $returnToRoot
  342 + * @param boolean $includeAllowableActions
  343 + * @param boolean $includeRelationships
  344 + * @param boolean $returnToRoot
345 345 * @param string $filter
346 346 * @return ancestry[]
347 347 */
... ... @@ -373,8 +373,8 @@ class KTCMIS {
373 373 *
374 374 * @param string $repositoryId
375 375 * @param string $folderId
376   - * @param bool $includeAllowableActions
377   - * @param bool $includeRelationships
  376 + * @param boolean $includeAllowableActions
  377 + * @param boolean $includeRelationships
378 378 * @param string $filter
379 379 * @return ancestry[]
380 380 */
... ... @@ -411,8 +411,8 @@ class KTCMIS {
411 411 *
412 412 * @param string $repositoryId
413 413 * @param string $objectId
414   - * @param bool $includeAllowableActions
415   - * @param bool $includeRelationships
  414 + * @param boolean $includeAllowableActions
  415 + * @param boolean $includeRelationships
416 416 * @param string $returnVersion
417 417 * @param string $filter
418 418 * @return properties[]
... ...
ktcmis/services/CMISNavigationService.inc.php
  View file @cbaf75b
... ... @@ -58,8 +58,8 @@ class CMISNavigationService {
58 58 *
59 59 * @param string $repositoryId
60 60 * @param string $folderId
61   - * @param bool $includeAllowableActions
62   - * @param bool $includeRelationships
  61 + * @param boolean $includeAllowableActions
  62 + * @param boolean $includeRelationships
63 63 * @param string $typeId
64 64 * @param int $depth
65 65 * @param string $filter
... ... @@ -101,8 +101,8 @@ class CMISNavigationService {
101 101 *
102 102 * @param string $repositoryId
103 103 * @param string $folderId
104   - * @param bool $includeAllowableActions
105   - * @param bool $includeRelationships
  104 + * @param boolean $includeAllowableActions
  105 + * @param boolean $includeRelationships
106 106 * @param string $typeId
107 107 * @param string $filter
108 108 * @param int $maxItems
... ... @@ -142,9 +142,9 @@ class CMISNavigationService {
142 142 *
143 143 * @param string $repositoryId
144 144 * @param string $folderId
145   - * @param bool $includeAllowableActions
146   - * @param bool $includeRelationships
147   - * @param bool $returnToRoot If TRUE, then the repository SHALL return all folder objects
  145 + * @param boolean $includeAllowableActions
  146 + * @param boolean $includeRelationships
  147 + * @param boolean $returnToRoot If TRUE, then the repository SHALL return all folder objects
148 148 * that are ancestors of the specified folder.
149 149 * If FALSE, the repository SHALL return only the parent folder of the specified folder.
150 150 * @param string $filter
... ... @@ -168,7 +168,6 @@ class CMISNavigationService {
168 168  
169 169 $ktapiFolder = $this->ktapi->get_folder_by_id($folderId);
170 170  
171   - // TODO return full ancestry on $returnToRoot == true
172 171 if ($returnToRoot)
173 172 {
174 173 $folder = $ktapiFolder->get_folder();
... ... @@ -200,11 +199,15 @@ class CMISNavigationService {
200 199 }
201 200  
202 201 /**
  202 + * Fetches the parent(s) of the specified object
  203 + * Multiple parents may exist if a repository supports multi-filing
  204 + * It is also possible that linked documents/folders may qualify as having multiple parents
  205 + * as they are essentially the same object
203 206 *
204 207 * @param string $repositoryId
205 208 * @param string $objectId
206   - * @param bool $includeAllowableActions
207   - * @param bool $includeRelationships
  209 + * @param boolean $includeAllowableActions
  210 + * @param boolean $includeRelationships
208 211 * @param string $filter
209 212 * @return array $parents
210 213 */
... ... @@ -232,19 +235,6 @@ class CMISNavigationService {
232 235 break;
233 236 }
234 237  
235   -// echo 'PARENT<BR><pre>'.print_r($parent, true).'</pre>';
236   -//
237   -//echo '<pre>'.print_r($ancestry, true).'</pre>';
238   -// // need some info about the parent(s) in order to correctly create the hierarchy
239   -// $tmpArray = array();
240   -// foreach ($ancestry as $key => $ancestor)
241   -// {
242   -// echo '<pre>'.print_r($ancestor, true).'</pre>';
243   -// $tmpArray[$key] = $this->ktapi->get_folder_by_id($ancestor);
244   -// }
245   -// $ancestry = $tmpArray;
246   -// unset($tmpArray);
247   -
248 238 $ancestry = CMISUtil::createParentObjectHierarchy($ancestry, $repository->getRepositoryURI, $this->ktapi);
249 239  
250 240 return $ancestry;
... ...
ktcmis/services/CMISObjectService.inc.php
  View file @cbaf75b
... ... @@ -21,9 +21,9 @@ class CMISObjectService {
21 21 *
22 22 * @param string $repositoryId
23 23 * @param string $objectId
24   - * @param bool $includeAllowableActions
25   - * @param bool $includeRelationships
26   - * @param bool $returnVersion
  24 + * @param boolean $includeAllowableActions
  25 + * @param boolean $includeRelationships
  26 + * @param boolean $returnVersion
27 27 * @param string $filter
28 28 * @return object CMIS object properties
29 29 */
... ...