/[drupal]/contributions/modules/kt/includes/KnowledgeTreeService_REST.php
ViewVC logotype

Diff of /contributions/modules/kt/includes/KnowledgeTreeService_REST.php

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1, Wed Aug 12 09:32:28 2009 UTC revision 1.1.2.1, Wed Aug 12 09:32:28 2009 UTC
# Line 0  Line 1 
1    <?php
2    
3    /*
4     * Generated automatically from KT 3.6.1 WSDL
5     * Using WSDL->PHP generator http://code.google.com/p/wsdl2php-interpreter/
6     * with a few custom tweaks
7     *
8     * Added login code and REST call function
9     *
10     * @author aantonop
11     */
12    include "KnowledgeTreeService_classes.php";
13    
14    if (!class_exists("KnowledgeTreeRESTService")) {
15    
16    
17      /**
18       * KnowledgeTreeRESTService
19       * @author WSDLInterpreter
20       */
21      class KnowledgeTreeRESTService {
22        /**
23         * Default class map for wsdl=>php
24         * @access private
25         * @var array
26         */
27        private static $classmap = array(
28                    "kt_response" => "kt_response",
29                    "kt_folder_detail" => "kt_folder_detail",
30                    "kt_folder_item" => "kt_folder_item",
31                    "kt_folder_items" => "kt_folder_items",
32                    "kt_folder_contents" => "kt_folder_contents",
33                    "kt_document_detail" => "kt_document_detail",
34                    "kt_search_result_item" => "kt_search_result_item",
35                    "kt_search_results" => "kt_search_results",
36                    "kt_search_response" => "kt_search_response",
37                    "kt_sysdata_item" => "kt_sysdata_item",
38                    "kt_sysdata" => "kt_sysdata",
39                    "kt_metadata_selection_item" => "kt_metadata_selection_item",
40                    "kt_metadata_selection" => "kt_metadata_selection",
41                    "kt_metadata_field" => "kt_metadata_field",
42                    "kt_metadata_fields" => "kt_metadata_fields",
43                    "kt_metadata_fieldset" => "kt_metadata_fieldset",
44                    "kt_metadata_fieldsets" => "kt_metadata_fieldsets",
45                    "kt_metadata_response" => "kt_metadata_response",
46                    "kt_workflow_transitions" => "kt_workflow_transitions",
47                    "kt_workflow_transitions_response" => "kt_workflow_transitions_response",
48                    "kt_workflows_array" => "kt_workflows_array",
49                    "kt_workflows_response" => "kt_workflows_response",
50                    "kt_document_transaction_history_item" => "kt_document_transaction_history_item",
51                    "kt_linked_document" => "kt_linked_document",
52                    "kt_linked_documents" => "kt_linked_documents",
53                    "kt_linked_document_response" => "kt_linked_document_response",
54                    "kt_document_transaction_history" => "kt_document_transaction_history",
55                    "kt_document_transaction_history_response" => "kt_document_transaction_history_response",
56                    "kt_document_version_history_item" => "kt_document_version_history_item",
57                    "kt_document_collection" => "kt_document_collection",
58                    "kt_document_collection_response" => "kt_document_collection_response",
59                    "kt_folder_collection" => "kt_folder_collection",
60                    "kt_folder_collection_response" => "kt_folder_collection_response",
61                    "kt_document_version_history" => "kt_document_version_history",
62                    "kt_document_version_history_response" => "kt_document_version_history_response",
63                    "kt_document_types_array" => "kt_document_types_array",
64                    "kt_document_types_response" => "kt_document_types_response",
65                    "kt_client_policy" => "kt_client_policy",
66                    "kt_client_policies_array" => "kt_client_policies_array",
67                    "kt_client_policies_response" => "kt_client_policies_response",
68        );
69    
70        /**
71         * Store session URL and session ID
72         */
73        var $session = Array(
74            'session_id' => NULL,
75            'session_url' => '', // Example: 'http://localhost/ktwebservice/KTWebService.php'
76            'username' => '',
77        );
78    
79        /**
80         * A very basic error log, as a string
81         * @var string
82         */
83        public $error;
84    
85        /**
86         * Log an error or debug notice
87         *
88         * This is meant to be extended by a child class to provide real logging
89         * for example, extend and send to syslog or a file or multiple files
90         *
91         * This stub ignores the level argument and simply appends to the error string
92         *
93         */
94        function log($log, $level="ERROR") {
95          $this->error .= "\n". $error;
96        }
97    
98        /**
99         * Call the REST API over HTTP
100         *
101         * All the stub functions use this to make the REST call
102         * If there is an existing session it uses it. If not you can only call "login" to set a session up.
103         *
104         */
105        function _kt_REST_call($method, $args) {
106    
107          $url = $this->session['session_url'].'?';
108    
109          // Check if there is an existing session or if this is the login call
110          if (!isset($this->session['session_id']) && $method != "login") { // Haven't opened a session yet, must log in first
111            $this->log("Trying to execute method ". $method ." without an established session. You must call login method first!", "ERROR");
112            return FALSE;
113          } // Either login method or session exists
114          else if (isset($this->session['session_id'])) { // Session exists
115            $url = $url.'session_id='. $this->session['session_id'] ."&";
116          }
117    
118          $rest_call_url = $url ."method=". $method . $args;
119          $this->log("Executing REST call: ".$rest_call_url, "DEBUG");
120    
121          if ($response = $this->_kt_http_get($rest_call_url)) { // HTTP call succeeded
122    
123            $response = simplexml_load_string($response); // Convert REST XML response to structured object using SimpleXML library
124    
125            if ($response->status_code == 0) { // REST call success
126              $this->log("\n\n=======\n\nREST Call Request: ".$rest_call_url."\nCall Results: ".print_r($response->results,TRUE)."\n\n========\n", "DEBUG");
127              return $response->results;
128            }
129            else { // REST Call failed
130              $this->log('REST Call failed with message: '. $response->message, "ERROR");
131              return FALSE;
132            }
133          }
134          else { // HTTP call failed
135            return FALSE;
136          }
137        }
138    
139        /**
140         * Make an HTTP call
141         * This is meant to be extended and overriden by whatever HTTP library you use
142         * eg. curl or pecl_http
143         * This example uses drupal's http request
144         *
145         */
146        function _kt_http_get ($url) {
147    
148          $response = drupal_http_request($url, array('Content-Type' => 'text/xml'), "GET");
149    
150          if($response->code == 200) { // HTTP Call success
151            $this->log("HTTP Call succeeded for ". $url, "DEBUG");
152            return $response->data;
153          }
154          else { // HTTP Call failed
155            $this->log('HTTP Error '. $response->code .' - on REST Call with URL '. $url, "ERROR");
156            return FALSE;
157          }
158        }
159    
160        /**
161         * REST Call: login
162         *
163         * @author aantonop - rewritten from stub
164         *
165         * Parameter options:
166         * (string) username, (string) password, (string) ip
167         * @return (boolean) success, stores session in object
168         */
169        function login($url, $username, $password) {
170    
171          $this->session = array(
172            'session_url' => $url,
173            'username' => $username,
174          );
175    
176          if ($response = $this->_kt_REST_call("login", "&username=". urlencode($username) ."&password=". urlencode($password))) {
177            $this->session['session_id'] = (string)$response;
178            return TRUE;
179          }
180          else {
181            $this->log("Login Failed", "ERROR");
182            return FALSE;
183          }
184    
185        }
186    
187    
188        /**
189         *
190         * Rest of these functions are stubs. They may work "right out of the box" or may need some tweaking
191         * Not all the functions listed in the WSDL are currently supported by the REST API
192         * Some are only supported by the SOAP API
193         *
194         */
195    
196            /**
197             * REST Call: search
198             *
199             * Read the document search2/docs/userguide.txt in KT's root directory
200             *
201             * The core of the search engine is the 'expression language'.
202         * Expressions may be built up using the following grammar:
203         * expr ::= expr { AND | OR } expr
204         * expr ::= NOT expr
205         * expr ::= expr { < | <= | = | > | >= | CONTAINS |STARTS WITH | ENDS WITH } value
206         * expr ::= field BETWEEN value AND value
207         * expr ::= field DOES [ NOT ] CONTAIN value
208         * expr ::= field IS [ NOT ] LIKE value
209         * value ::= "search text here"
210         *
211         * A field may be one of the following:
212         * CheckedOut , CheckedOutBy , CheckedoutDelta , Created , CreatedBy , CreatedDelta , DiscussionText , DocumentId ,
213         * DocumentText , DocumentType , Filename , Filesize , Folder , GeneralText , IsCheckedOut , IsImmutable ,
214         * Metadata , MimeType , Modified , ModifiedBy , ModifiedDelta , Tag , Title , Workflow ,
215         * WorkflowID , WorkflowState , WorkflowStateID
216         *
217         * A 'field' may also refer to metadata using the following syntax:
218         * ["fieldset name"]["field name"]
219         *
220         * Note that 'values' must be contained within "double quotes".
221         *
222         * Example for $search argument: 'Filename CONTAINS "e"'
223         *
224         * Note: $options seems to be ignored, but has to contain a value. I pass "none" and it works
225         *
226         *
227             * Parameter options:
228             * (string) search, (string) options
229             * @return kt_search_response
230             */
231            public function search($search, $options) {
232                    $rest_args = '&query='. urlencode($search) .'&options='. urlencode($options);
233                    return $this->_kt_REST_call("search", $rest_args);
234            }
235    
236    
237            /**
238             * REST Call: anonymous_login
239             * Parameter options:
240             * (string) ip
241             * @return kt_response
242             */
243            public function anonymous_login($ip) {
244                    $rest_args = '&ip='. urlencode($ip);
245                    return $this->_kt_REST_call("anonymous_login", $rest_args);
246            }
247    
248    
249            /**
250             * REST Call: logout
251             * @return kt_response
252             */
253            public function logout() {
254                    return $this->_kt_REST_call("logout", "");
255            }
256    
257    
258            /**
259             * REST Call: get_folder_detail
260             * Parameter options:
261             * (integer) folder_id
262             * @return kt_folder_detail
263             */
264            public function get_folder_detail($folder_id) {
265                    $rest_args = '&folder_id='. urlencode($folder_id);
266                    return $this->_kt_REST_call("get_folder_detail", $rest_args);
267            }
268    
269    
270            /**
271             * REST Call: get_documents_by_oem_no
272             * Parameter options:
273             * (string) oem_no, (string) detail
274             * @return kt_document_collection_response
275             */
276            public function get_documents_by_oem_no($oem_no, $detail) {
277                    $rest_args = '&oem_no='. urlencode($oem_no) .'&detail='. urlencode($detail);
278                    return $this->_kt_REST_call("get_documents_by_oem_no", $rest_args);
279            }
280    
281    
282            /**
283             * REST Call: get_folder_detail_by_name
284             * Parameter options:
285             * (string) folder_name
286             * @return kt_folder_detail
287             */
288            public function get_folder_detail_by_name($folder_name) {
289                    $rest_args = '&folder_name='. urlencode($folder_name);
290                    return $this->_kt_REST_call("get_folder_detail_by_name", $rest_args);
291            }
292    
293    
294            /**
295             * REST Call: get_folder_contents
296             * Parameter options:
297             * (integer) folder_id, (integer) depth, (string) what
298             * @return kt_folder_contents
299             */
300            public function get_folder_contents($folder_id, $depth, $what) {
301                    $rest_args = '&folder_id='. urlencode($folder_id) .'&depth='. urlencode($depth) .'&what='. urlencode($what);
302                    return $this->_kt_REST_call("get_folder_contents", $rest_args);
303            }
304    
305    
306            /**
307             * REST Call: create_folder
308             * Parameter options:
309             * (integer) folder_id, (string) folder_name
310             * @return kt_folder_detail
311             */
312            public function create_folder($folder_id, $folder_name) {
313                    $rest_args = '&folder_id='. urlencode($folder_id) .'&folder_name='. urlencode($folder_name);
314                    return $this->_kt_REST_call("create_folder", $rest_args);
315            }
316    
317    
318            /**
319             * REST Call: add_folder
320             * Parameter options:
321             * (integer) folder_id, (string) folder_name
322             * @return kt_folder_detail
323             */
324            public function add_folder($folder_id, $folder_name) {
325                    $rest_args = '&folder_id='. urlencode($folder_id) .'&folder_name='. urlencode($folder_name);
326                    return $this->_kt_REST_call("add_folder", $rest_args);
327            }
328    
329    
330            /**
331             * REST Call: delete_folder
332             * Parameter options:
333             * (integer) folder_id, (string) reason
334             * @return kt_response
335             */
336            public function delete_folder($folder_id, $reason) {
337                    $rest_args = '&folder_id='. urlencode($folder_id) .'&reason='. urlencode($reason);
338                    return $this->_kt_REST_call("delete_folder", $rest_args);
339            }
340    
341    
342            /**
343             * REST Call: rename_folder
344             * Parameter options:
345             * (integer) folder_id, (string) newname
346             * @return kt_response
347             */
348            public function rename_folder($folder_id, $newname) {
349                    $rest_args = '&folder_id='. urlencode($folder_id) .'&newname='. urlencode($newname);
350                    return $this->_kt_REST_call("rename_folder", $rest_args);
351            }
352    
353    
354            /**
355             * REST Call: get_document_links
356             * Parameter options:
357             * (integer) document_id
358             * @return kt_linked_document_response
359             */
360            public function get_document_links($document_id) {
361                    $rest_args = '&document_id='. urlencode($document_id);
362                    return $this->_kt_REST_call("get_document_links", $rest_args);
363            }
364    
365    
366            /**
367             * REST Call: link_documents
368             * Parameter options:
369             * (integer) parent_document_id, (integer) child_document_id, (string) type
370             * @return kt_response
371             */
372            public function link_documents($parent_document_id, $child_document_id, $type) {
373                    $rest_args = '&parent_document_id='. urlencode($parent_document_id) .'&child_document_id='. urlencode($child_document_id) .'&type='. urlencode($type);
374                    return $this->_kt_REST_call("link_documents", $rest_args);
375            }
376    
377    
378            /**
379             * REST Call: unlink_documents
380             * Parameter options:
381             * (integer) parent_document_id, (integer) child_document_id
382             * @return kt_response
383             */
384            public function unlink_documents($parent_document_id, $child_document_id) {
385                    $rest_args = '&parent_document_id='. urlencode($parent_document_id) .'&child_document_id='. urlencode($child_document_id);
386                    return $this->_kt_REST_call("unlink_documents", $rest_args);
387            }
388    
389    
390            /**
391             * REST Call: copy_folder
392             * Parameter options:
393             * (integer) source_id, (integer) target_id, (string) reason
394             * @return kt_folder_detail
395             */
396            public function copy_folder($source_id, $target_id, $reason) {
397                    $rest_args = '&source_id='. urlencode($source_id) .'&target_id='. urlencode($target_id) .'&reason='. urlencode($reason);
398                    return $this->_kt_REST_call("copy_folder", $rest_args);
399            }
400    
401    
402            /**
403             * REST Call: move_folder
404             * Parameter options:
405             * (integer) source_id, (integer) target_id, (string) reason
406             * @return kt_folder_detail
407             */
408            public function move_folder($source_id, $target_id, $reason) {
409                    $rest_args = '&source_id='. urlencode($source_id) .'&target_id='. urlencode($target_id) .'&reason='. urlencode($reason);
410                    return $this->_kt_REST_call("move_folder", $rest_args);
411            }
412    
413    
414            /**
415             * REST Call: get_document_detail
416             * Parameter options:
417             * (integer) document_id, (string) detail
418             * @return kt_document_detail
419             */
420            public function get_document_detail($document_id, $detail) {
421                    $rest_args = '&document_id='. urlencode($document_id) .'&detail='. urlencode($detail);
422                    return $this->_kt_REST_call("get_document_detail", $rest_args);
423            }
424    
425    
426            /**
427             * REST Call: checkin_document
428             * Parameter options:
429             * (integer) document_id, (string) filename, (string) reason, (string) tempfilename, (boolean) major_update
430             * @return kt_document_detail
431             */
432            public function checkin_document($document_id, $filename, $reason, $tempfilename, $major_update) {
433                    $rest_args = '&document_id='. urlencode($document_id) .'&filename='. urlencode($filename) .'&reason='. urlencode($reason) .'&tempfilename='. urlencode($tempfilename) .'&major_update='. urlencode($major_update);
434                    return $this->_kt_REST_call("checkin_document", $rest_args);
435            }
436    
437    
438            /**
439             * REST Call: checkin_small_document
440             * Parameter options:
441             * (integer) document_id, (string) filename, (string) reason, (string) base64, (boolean) major_update
442             * @return kt_document_detail
443             */
444            public function checkin_small_document($document_id, $filename, $reason, $base64, $major_update) {
445                    $rest_args = '&document_id='. urlencode($document_id) .'&filename='. urlencode($filename) .'&reason='. urlencode($reason) .'&base64='. urlencode($base64) .'&major_update='. urlencode($major_update);
446                    return $this->_kt_REST_call("checkin_small_document", $rest_args);
447            }
448    
449    
450            /**
451             * REST Call: checkin_base64_document
452             * Parameter options:
453             * (integer) document_id, (string) filename, (string) reason, (string) base64, (boolean) major_update
454             * @return kt_document_detail
455             */
456            public function checkin_base64_document($document_id, $filename, $reason, $base64, $major_update) {
457                    $rest_args = '&document_id='. urlencode($document_id) .'&filename='. urlencode($filename) .'&reason='. urlencode($reason) .'&base64='. urlencode($base64) .'&major_update='. urlencode($major_update);
458                    return $this->_kt_REST_call("checkin_base64_document", $rest_args);
459            }
460    
461    
462            /**
463             * REST Call: checkin_base64_document_with_metadata
464             * Parameter options:
465             * (integer) document_id, (string) filename, (string) reason, (string) base64, (boolean) major_update, (kt_metadata_fieldsets) metadata, (kt_sysdata) sysdata
466             * @return kt_document_detail
467             */
468            public function checkin_base64_document_with_metadata($document_id, $filename, $reason, $base64, $major_update, $metadata, $sysdata) {
469                    $rest_args = '&document_id='. urlencode($document_id) .'&filename='. urlencode($filename) .'&reason='. urlencode($reason) .'&base64='. urlencode($base64) .'&major_update='. urlencode($major_update) .'&metadata='. urlencode($metadata) .'&sysdata='. urlencode($sysdata);
470                    return $this->_kt_REST_call("checkin_base64_document_with_metadata", $rest_args);
471            }
472    
473    
474            /**
475             * REST Call: checkin_document_with_metadata
476             * Parameter options:
477             * (integer) document_id, (string) filename, (string) reason, (string) tempfilename, (boolean) major_update, (kt_metadata_fieldsets) metadata, (kt_sysdata) sysdata
478             * @return kt_document_detail
479             */
480            public function checkin_document_with_metadata($document_id, $filename, $reason, $tempfilename, $major_update, $metadata, $sysdata) {
481                    $rest_args = '&document_id='. urlencode($document_id) .'&filename='. urlencode($filename) .'&reason='. urlencode($reason) .'&tempfilename='. urlencode($tempfilename) .'&major_update='. urlencode($major_update) .'&metadata='. urlencode($metadata) .'&sysdata='. urlencode($sysdata);
482                    return $this->_kt_REST_call("checkin_document_with_metadata", $rest_args);
483            }
484    
485    
486            /**
487             * REST Call: add_document
488             * Parameter options:
489             * (integer) folder_id, (string) title, (string) filename, (string) documentype, (string) tempfilename
490             * @return kt_document_detail
491             */
492            public function add_document($folder_id, $title, $filename, $documentype, $tempfilename) {
493                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&filename='. urlencode($filename) .'&documentype='. urlencode($documentype) .'&tempfilename='. urlencode($tempfilename);
494                    return $this->_kt_REST_call("add_document", $rest_args);
495            }
496    
497    
498            /**
499             * REST Call: add_small_document
500             * Parameter options:
501             * (integer) folder_id, (string) title, (string) filename, (string) documentype, (string) base64
502             * @return kt_document_detail
503             */
504            public function add_small_document($folder_id, $title, $filename, $documentype, $base64) {
505                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&filename='. urlencode($filename) .'&documentype='. urlencode($documentype) .'&base64='. urlencode($base64);
506                    return $this->_kt_REST_call("add_small_document", $rest_args);
507            }
508    
509    
510            /**
511             * REST Call: add_base64_document
512             * Parameter options:
513             * (integer) folder_id, (string) title, (string) filename, (string) documentype, (string) base64
514             * @return kt_document_detail
515             */
516            public function add_base64_document($folder_id, $title, $filename, $documentype, $base64) {
517                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&filename='. urlencode($filename) .'&documentype='. urlencode($documentype) .'&base64='. urlencode($base64);
518                    return $this->_kt_REST_call("add_base64_document", $rest_args);
519            }
520    
521    
522            /**
523             * REST Call: add_base64_document_with_metadata
524             * Parameter options:
525             * (integer) folder_id, (string) title, (string) filename, (string) documentype, (string) base64, (kt_metadata_fieldsets) metadata, (kt_sysdata) sysdata
526             * @return kt_document_detail
527             */
528            public function add_base64_document_with_metadata($folder_id, $title, $filename, $documentype, $base64, $metadata, $sysdata) {
529                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&filename='. urlencode($filename) .'&documentype='. urlencode($documentype) .'&base64='. urlencode($base64) .'&metadata='. urlencode($metadata) .'&sysdata='. urlencode($sysdata);
530                    return $this->_kt_REST_call("add_base64_document_with_metadata", $rest_args);
531            }
532    
533    
534            /**
535             * REST Call: add_document_with_metadata
536             * Parameter options:
537             * (integer) folder_id, (string) title, (string) filename, (string) documentype, (string) tempfilename, (kt_metadata_fieldsets) metadata, (kt_sysdata) sysdata
538             * @return kt_document_detail
539             */
540            public function add_document_with_metadata($folder_id, $title, $filename, $documentype, $tempfilename, $metadata, $sysdata) {
541                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&filename='. urlencode($filename) .'&documentype='. urlencode($documentype) .'&tempfilename='. urlencode($tempfilename) .'&metadata='. urlencode($metadata) .'&sysdata='. urlencode($sysdata);
542                    return $this->_kt_REST_call("add_document_with_metadata", $rest_args);
543            }
544    
545    
546            /**
547             * REST Call: get_document_detail_by_name
548             * Parameter options:
549             * (integer) folder_id, (string) document_name, (string) what, (string) detail
550             * @return kt_document_detail
551             */
552            public function get_document_detail_by_name($folder_id, $document_name, $what, $detail) {
553                    $rest_args = '&folder_id='. urlencode($folder_id) .'&document_name='. urlencode($document_name) .'&what='. urlencode($what) .'&detail='. urlencode($detail);
554                    return $this->_kt_REST_call("get_document_detail_by_name", $rest_args);
555            }
556    
557    
558            /**
559             * REST Call: get_document_detail_by_title
560             * Parameter options:
561             * (integer) folder_id, (string) title, (string) detail
562             * @return kt_document_detail
563             */
564            public function get_document_detail_by_title($folder_id, $title, $detail) {
565                    $rest_args = '&folder_id='. urlencode($folder_id) .'&title='. urlencode($title) .'&detail='. urlencode($detail);
566                    return $this->_kt_REST_call("get_document_detail_by_title", $rest_args);
567            }
568    
569    
570            /**
571             * REST Call: get_document_detail_by_filename
572             * Parameter options:
573             * (integer) folder_id, (string) filename, (string) detail
574             * @return kt_document_detail
575             */
576            public function get_document_detail_by_filename($folder_id, $filename, $detail) {
577                    $rest_args = '&folder_id='. urlencode($folder_id) .'&filename='. urlencode($filename) .'&detail='. urlencode($detail);
578                    return $this->_kt_REST_call("get_document_detail_by_filename", $rest_args);
579            }
580    
581    
582            /**
583             * REST Call: checkout_document
584             * Parameter options:
585             * (integer) document_id, (string) reason, (boolean) download
586             * @return kt_document_detail
587             */
588            public function checkout_document($document_id, $reason, $download) {
589                    $rest_args = '&document_id='. urlencode($document_id) .'&reason='. urlencode($reason) .'&download='. urlencode($download);
590                    return $this->_kt_REST_call("checkout_document", $rest_args);
591            }
592    
593    
594            /**
595             * REST Call: checkout_small_document
596             * Parameter options:
597             * (integer) document_id, (string) reason, (boolean) download
598             * @return kt_document_detail
599             */
600            public function checkout_small_document($document_id, $reason, $download) {
601                    $rest_args = '&document_id='. urlencode($document_id) .'&reason='. urlencode($reason) .'&download='. urlencode($download);
602                    return $this->_kt_REST_call("checkout_small_document", $rest_args);
603            }
604    
605    
606            /**
607             * REST Call: checkout_base64_document
608             * Parameter options:
609             * (integer) document_id, (string) reason, (boolean) download
610             * @return kt_document_detail
611             */
612            public function checkout_base64_document($document_id, $reason, $download) {
613                    $rest_args = '&document_id='. urlencode($document_id) .'&reason='. urlencode($reason) .'&download='. urlencode($download);
614                    return $this->_kt_REST_call("checkout_base64_document", $rest_args);
615            }
616    
617    
618            /**
619             * REST Call: undo_document_checkout
620             * Parameter options:
621             * (integer) document_id, (string) reason
622             * @return kt_document_detail
623             */
624            public function undo_document_checkout($document_id, $reason) {
625                    $rest_args = '&document_id='. urlencode($document_id) .'&reason='. urlencode($reason);
626                    return $this->_kt_REST_call("undo_document_checkout", $rest_args);
627            }
628    
629    
630            /**
631             * REST Call: download_document
632             * Parameter options:
633             * (integer) document_id
634             * @return kt_response
635             */
636            public function download_document($document_id) {
637                    $rest_args = '&document_id='. urlencode($document_id);
638                    return $this->_kt_REST_call("download_document", $rest_args);
639            }
640    
641    
642            /**
643             * REST Call: download_small_document
644             * Parameter options:
645             * (integer) document_id
646             * @return kt_response
647             */
648            public function download_small_document($document_id) {
649                    $rest_args = '&document_id='. urlencode($document_id);
650                    return $this->_kt_REST_call("download_small_document", $rest_args);
651            }
652    
653    
654            /**
655             * REST Call: download_base64_document
656             * Parameter options:
657             * (integer) document_id
658             * @return kt_response
659             */
660            public function download_base64_document($document_id) {
661                    $rest_args = '&document_id='. urlencode($document_id);
662                    return $this->_kt_REST_call("download_base64_document", $rest_args);
663            }
664    
665    
666            /**
667             * REST Call: delete_document
668             * Parameter options:
669             * (integer) document_id, (string) reason
670             * @return kt_response
671             */
672            public function delete_document($document_id, $reason) {
673                    $rest_args = '&document_id='. urlencode($document_id) .'&reason='. urlencode($reason);
674                    return $this->_kt_REST_call("delete_document", $rest_args);
675            }
676    
677    
678            /**
679             * REST Call: change_document_owner
680             * Parameter options:
681             * (integer) document_id, (string) username, (string) reason
682             * @return kt_document_detail
683             */
684            public function change_document_owner($document_id, $username, $reason) {
685                    $rest_args = '&document_id='. urlencode($document_id) .'&username='. urlencode($username) .'&reason='. urlencode($reason);
686                    return $this->_kt_REST_call("change_document_owner", $rest_args);
687            }
688    
689    
690            /**
691             * REST Call: copy_document
692             * Parameter options:
693             * (integer) document_id, (integer) folder_id, (string) reason, (string) options
694             * @return kt_document_detail
695             */
696            public function copy_document($document_id, $folder_id, $reason, $options) {
697                    $rest_args = '&document_id='. urlencode($document_id) .'&folder_id='. urlencode($folder_id) .'&reason='. urlencode($reason) .'&options='. urlencode($options);
698                    return $this->_kt_REST_call("copy_document", $rest_args);
699            }
700    
701    
702            /**
703             * REST Call: move_document
704             * Parameter options:
705             * (integer) document_id, (integer) folder_id, (string) reason, (string) options
706             * @return kt_document_detail
707             */
708            public function move_document($document_id, $folder_id, $reason, $options) {
709                    $rest_args = '&document_id='. urlencode($document_id) .'&folder_id='. urlencode($folder_id) .'&reason='. urlencode($reason) .'&options='. urlencode($options);
710                    return $this->_kt_REST_call("move_document", $rest_args);
711            }
712    
713    
714            /**
715             * REST Call: rename_document_title
716             * Parameter options:
717             * (integer) document_id, (string) newtitle
718             * @return kt_document_detail
719             */
720            public function rename_document_title($document_id, $newtitle) {
721                    $rest_args = '&document_id='. urlencode($document_id) .'&newtitle='. urlencode($newtitle);
722                    return $this->_kt_REST_call("rename_document_title", $rest_args);
723            }
724    
725    
726            /**
727             * REST Call: rename_document_filename
728             * Parameter options:
729             * (integer) document_id, (string) newfilename
730             * @return kt_document_detail
731             */
732            public function rename_document_filename($document_id, $newfilename) {
733                    $rest_args = '&document_id='. urlencode($document_id) .'&newfilename='. urlencode($newfilename);
734                    return $this->_kt_REST_call("rename_document_filename", $rest_args);
735            }
736    
737    
738            /**
739             * REST Call: change_document_type
740             * Parameter options:
741             * (integer) document_id, (string) documenttype
742             * @return kt_document_detail
743             */
744            public function change_document_type($document_id, $documenttype) {
745                    $rest_args = '&document_id='. urlencode($document_id) .'&documenttype='. urlencode($documenttype);
746                    return $this->_kt_REST_call("change_document_type", $rest_args);
747            }
748    
749    
750            /**
751             * REST Call: start_document_workflow
752             * Parameter options:
753             * (integer) document_id, (string) workflow
754             * @return kt_document_detail
755             */
756            public function start_document_workflow($document_id, $workflow) {
757                    $rest_args = '&document_id='. urlencode($document_id) .'&workflow='. urlencode($workflow);
758                    return $this->_kt_REST_call("start_document_workflow", $rest_args);
759            }
760    
761    
762            /**
763             * REST Call: delete_document_workflow
764             * Parameter options:
765             * (integer) document_id
766             * @return kt_document_detail
767             */
768            public function delete_document_workflow($document_id) {
769                    $rest_args = '&document_id='. urlencode($document_id);
770                    return $this->_kt_REST_call("delete_document_workflow", $rest_args);
771            }
772    
773    
774            /**
775             * REST Call: stop_document_workflow
776             * Parameter options:
777             * (integer) document_id
778             * @return kt_document_detail
779             */
780            public function stop_document_workflow($document_id) {
781                    $rest_args = '&document_id='. urlencode($document_id);
782                    return $this->_kt_REST_call("stop_document_workflow", $rest_args);
783            }
784    
785    
786            /**
787             * REST Call: perform_document_workflow_transition
788             * Parameter options:
789             * (integer) document_id, (string) transition, (string) reason
790             * @return kt_document_detail
791             */
792            public function perform_document_workflow_transition($document_id, $transition, $reason) {
793                    $rest_args = '&document_id='. urlencode($document_id) .'&transition='. urlencode($transition) .'&reason='. urlencode($reason);
794                    return $this->_kt_REST_call("perform_document_workflow_transition", $rest_args);
795            }
796    
797    
798            /**
799             * REST Call: get_document_metadata
800             * Parameter options:
801             * (integer) document_id
802             * @return kt_metadata_response
803             */
804            public function get_document_metadata($document_id) {
805                    $rest_args = '&document_id='. urlencode($document_id);
806                    return $this->_kt_REST_call("get_document_metadata", $rest_args);
807            }
808    
809    
810            /**
811             * REST Call: get_document_type_metadata
812             * Parameter options:
813             * (string) document_type
814             * @return kt_metadata_response
815             */
816            public function get_document_type_metadata($document_type) {
817                    $rest_args = '&document_type='. urlencode($document_type);
818                    return $this->_kt_REST_call("get_document_type_metadata", $rest_args);
819            }
820    
821    
822            /**
823             * REST Call: update_document_metadata
824             * Parameter options:
825             * (integer) document_id, (kt_metadata_fieldsets) metadata, (kt_sysdata) sysdata
826             * @return kt_document_detail
827             */
828            public function update_document_metadata($document_id, $metadata, $sysdata) {
829                    $rest_args = '&document_id='. urlencode($document_id) .'&metadata='. urlencode($metadata) .'&sysdata='. urlencode($sysdata);
830                    return $this->_kt_REST_call("update_document_metadata", $rest_args);
831            }
832    
833    
834            /**
835             * REST Call: get_document_workflow_transitions
836             * Parameter options:
837             * (integer) document_id
838             * @return kt_workflow_transitions_response
839             */
840            public function get_document_workflow_transitions($document_id) {
841                    $rest_args = '&document_id='. urlencode($document_id);
842                    return $this->_kt_REST_call("get_document_workflow_transitions", $rest_args);
843            }
844    
845    
846            /**
847             * REST Call: get_document_workflow_state
848             * Parameter options:
849             * (integer) document_id
850             * @return kt_response
851             */
852            public function get_document_workflow_state($document_id) {
853                    $rest_args = '&document_id='. urlencode($document_id);
854                    return $this->_kt_REST_call("get_document_workflow_state", $rest_args);
855            }
856    
857    
858            /**
859             * REST Call: get_document_transaction_history
860             * Parameter options:
861             * (integer) document_id
862             * @return kt_document_transaction_history_response
863             */
864            public function get_document_transaction_history($document_id) {
865                    $rest_args = '&document_id='. urlencode($document_id);
866                    return $this->_kt_REST_call("get_document_transaction_history", $rest_args);
867            }
868    
869    
870            /**
871             * REST Call: get_document_version_history
872             * Parameter options:
873             * (integer) document_id
874             * @return kt_document_version_history_response
875             */
876            public function get_document_version_history($document_id) {
877                    $rest_args = '&document_id='. urlencode($document_id);
878                    return $this->_kt_REST_call("get_document_version_history", $rest_args);
879            }
880    
881    
882            /**
883             * REST Call: get_document_types
884             * @return kt_document_types_response
885             */
886            public function get_document_types() {
887                    return $this->_kt_REST_call("get_document_types", "");
888            }
889    
890    
891            /**
892             * REST Call: get_workflows
893             * @return kt_workflows_response
894             */
895            public function get_workflows() {
896                    return $this->_kt_REST_call("get_workflows", "");
897            }
898    
899    
900            /**
901             * REST Call: get_document_link_types
902             * @return kt_document_types_response
903             */
904            public function get_document_link_types() {
905                    return $this->_kt_REST_call("get_document_link_types", "");
906            }
907    
908    
909            /**
910             * REST Call: get_client_policies
911             * Parameter options:
912             * (string) client
913             * @return kt_client_policies_response
914             */
915            public function get_client_policies($client) {
916                    $rest_args = '&client='. urlencode($client);
917                    return $this->_kt_REST_call("get_client_policies", $rest_args);
918            }
919    
920    
921    
922      }
923    }
924    
925    ?>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.1.2.1
  ViewVC Help
Powered by ViewVC 1.1.2