Docs For Class KTWebService

Class KTWebService

Description

Located in /ktwebservice/webservice.php (line 57)

Variable Summary

unknown_type $namespace

array $__dispatch_map

array $__typedef

Method Summary

static void run ()

KTWebService KTWebService ()

kt_document_detail. add_document (string $session_id, int $folder_id, string $title, string $filename, string $documenttype, string $tempfilename)

kt_response. change_document_owner (string $session_id, int $document_id, string $username, string $reason)

kt_response change_document_type (string $session_id, int $document_id, string $documenttype)

kt_document_detail. checkin_document (string $session_id, $document_id, string $filename, $reason, string $tempfilename, $major_update, int $folder_id, string $title, string $documenttype)

kt_response. checkout_document (string $session_id, int $document_id, string $reason)

kt_response copy_document (string $session_id, int $document_id, int $folder_id, string $reason, string $newtitle, string $newfilename)

kt_response copy_folder (string $session_id, $source_id, $target_id, string $reason, int $sourceid, int $targetid)

kt_folder_detail. create_folder (string $session_id, int $folder_id, string $folder_name)

kt_response delete_document (string $session_id, int $document_id, string $reason)

kt_response delete_document_workflow (string $session_id, int $document_id)

kt_response. delete_folder (string $session_id, int $folder_id, string $reason)

kt_response. download_document (string $session_id, int $document_id)

kt_document_detail. get_document_detail (string $session_id, int $document_id)

kt_document_detail. get_document_detail_by_name (string $session_id, string $document_name, [string $what = 'T'])

kt_metadata_response get_document_metadata (string $session_id, int $document_id)

kt_transaction_history_response get_document_transaction_history (string $session_id, int $document_id)

kt_document_types_response. get_document_types (string $session_id)

kt_version_history_response get_document_version_history (string $session_id, int $document_id)

kt_response get_document_workflow_state (string $session_id, int $document_id)

kt_workflow_transitions_response get_document_workflow_transitions (string $session_id, int $document_id)

kt_folder_contents get_folder_contents (string $session_id, int $folder_id, [int $depth = 1], [string $what = 'DF'])

kt_folder_detail. get_folder_detail (string $session_id, int $folder_id)

kt_folder_detail. get_folder_detail_by_name (string $session_id, string $folder_name)

KTAPI &get_ktapi (string $session_id)

kt_response login (string $username, string $password, [string $ip = null])

kt_response. logout (string $session_id)

kt_response move_document (string $session_id, int $document_id, int $folder_id, string $reason, string $newtitle, string $newfilename)

kt_response. move_folder (string $session_id, $source_id, $target_id, string $reason, int $sourceid, int $targetid)

kt_response perform_document_workflow_transition (string $session_id, int $document_id, string $transition, string $reason)

kt_response rename_document_filename (string $session_id, int $document_id, string $newfilename)

kt_response rename_document_title (string $session_id, int $document_id, string $newtitle)

kt_response. rename_folder (string $session_id, int $folder_id, string $newname)

kt_response start_document_workflow (string $session_id, int $document_id, string $workflow)

kt_response. undo_document_checkout (string $session_id, int $document_id, string $reason)

kt_response update_document_metadata (string $session_id, int $document_id, array $metadata)

void __dispatch ( $methodname)

Variables

unknown_type $namespace (line 79)

This is the namespace used by the web service.

array $__dispatch_map = array() (line 64)

Defines functions, parameters, and return values.

array $__typedef = array() (line 71)

Defines the structures that are used by web service functions.

Methods

static method run (line 2008)

This runs the web service

access: public

static void run ()

Constructor KTWebService (line 81)

KTWebService KTWebService ()

add_document (line 1104)

Adds a document to the repository.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_document_detail. add_document (string $session_id, int $folder_id, string $title, string $filename, string $documenttype, string $tempfilename)

string $session_id
int $folder_id
string $title
string $filename
string $documenttype
string $tempfilename

change_document_owner (line 1599)

Changes the owner of a document.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_response. change_document_owner (string $session_id, int $document_id, string $username, string $reason)

string $session_id
int $document_id
string $username
string $reason

change_document_type (line 1386)

Change the document type.

kt_response change_document_type (string $session_id, int $document_id, string $documenttype)

string $session_id
int $document_id
string $documenttype

checkin_document (line 1162)

Does a document checkin.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_document_detail. checkin_document (string $session_id, $document_id, string $filename, $reason, string $tempfilename, $major_update, int $folder_id, string $title, string $documenttype)

string $session_id
int $folder_id
string $title
string $filename
string $documenttype
string $tempfilename
$document_id
$reason
$major_update

checkout_document (line 1211)

Does a document checkout.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER or KTWS_SUCCESS

kt_response. checkout_document (string $session_id, int $document_id, string $reason)

string $session_id
int $document_id
string $reason

copy_document (line 1427)

Copy a document to another folder.

kt_response copy_document (string $session_id, int $document_id, int $folder_id, string $reason, string $newtitle, string $newfilename)

string $session_id
int $document_id
int $folder_id
string $reason
string $newtitle
string $newfilename

copy_folder (line 851)

Makes a copy of a folder in another location.

kt_response copy_folder (string $session_id, $source_id, $target_id, string $reason, int $sourceid, int $targetid)

string $session_id
int $sourceid
int $targetid
string $reason
$source_id
$target_id

create_folder (line 725)

Creates a new folder.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER or KTWS_SUCCESS

kt_folder_detail. create_folder (string $session_id, int $folder_id, string $folder_name)

string $session_id
int $folder_id
string $folder_name

delete_document (line 1347)

Deletes a document.

kt_response delete_document (string $session_id, int $document_id, string $reason)

string $session_id
int $document_id
string $reason

delete_document_workflow (line 1674)

Removes the workflow process on a document.

kt_response delete_document_workflow (string $session_id, int $document_id)

string $session_id
int $document_id

delete_folder (line 768)

Deletes a folder.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER or KTWS_SUCCESS

kt_response. delete_folder (string $session_id, int $folder_id, string $reason)

string $session_id
int $folder_id
string $reason

download_document (line 1300)

Returns a reference to a file to be downloaded.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_response. download_document (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_detail (line 990)

Returns document detail given a document_id.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_document_detail. get_document_detail (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_detail_by_name (line 1029)

Returns document detail given a document name which could include a full path.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_document_detail. get_document_detail_by_name (string $session_id, string $document_name, [string $what = 'T'])

string $session_id
string $document_name
string $what: @what

get_document_metadata (line 1750)

Returns the metadata on a document.

kt_metadata_response get_document_metadata (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_transaction_history (line 1929)

Returns the document transaction history.

kt_transaction_history_response get_document_transaction_history (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_types (line 956)

Returns a list of document types.

return: . status_code can be KTWS_ERR_INVALID_SESSION, KTWS_SUCCESS

kt_document_types_response. get_document_types (string $session_id)

string $session_id

get_document_version_history (line 1969)

Returns the version history.

kt_version_history_response get_document_version_history (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_workflow_state (line 1889)

Returns the current state that the document is in.

kt_response get_document_workflow_state (string $session_id, int $document_id)

string $session_id
int $document_id

get_document_workflow_transitions (line 1849)

Returns a list of available transitions on a give document with a workflow.

kt_workflow_transitions_response get_document_workflow_transitions (string $session_id, int $document_id)

string $session_id
int $document_id

get_folder_contents (line 685)

Returns the contents of a folder.

kt_folder_contents get_folder_contents (string $session_id, int $folder_id, [int $depth = 1], [string $what = 'DF'])

string $session_id
int $folder_id
int $depth
string $what

get_folder_detail (line 609)

Returns folder detail given a folder_id.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER, or KTWS_SUCCESS.

kt_folder_detail. get_folder_detail (string $session_id, int $folder_id)

string $session_id
int $folder_id

get_folder_detail_by_name (line 641)

Returns folder detail given a folder name which could include a full path.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER, or KTWS_SUCCESS.

kt_folder_detail. get_folder_detail_by_name (string $session_id, string $folder_name)

string $session_id
string $folder_name

get_ktapi (line 521)

This is used by all exposed functions dependant on the sessionid.

return: This could be KTAPI or kt_response array with status_code of KTWS_ERR_INVALID_SESSION.

KTAPI &get_ktapi (string $session_id)

string $session_id

Creates a new session for the user.

kt_response login (string $username, string $password, [string $ip = null])

string $username
string $password
string $ip

logout (line 576)

Closes an active session.

return: status_code can be KTWS_ERR_INVALID_SESSION or KTWS_SUCCESS.

kt_response. logout (string $session_id)

string $session_id

move_document (line 1476)

Move a folder to another location.

kt_response move_document (string $session_id, int $document_id, int $folder_id, string $reason, string $newtitle, string $newfilename)

string $session_id
int $document_id
int $folder_id
string $reason
string $newtitle
string $newfilename

move_folder (line 905)

Moves a folder to another location.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER or KTWS_SUCCESS

kt_response. move_folder (string $session_id, $source_id, $target_id, string $reason, int $sourceid, int $targetid)

string $session_id
int $sourceid
int $targetid
string $reason
$source_id
$target_id

perform_document_workflow_transition (line 1713)

Starts a transitions on a document with a workflow.

kt_response perform_document_workflow_transition (string $session_id, int $document_id, string $transition, string $reason)

string $session_id
int $document_id
string $transition
string $reason

rename_document_filename (line 1560)

Renames the document filename.

kt_response rename_document_filename (string $session_id, int $document_id, string $newfilename)

string $session_id
int $document_id
string $newfilename

rename_document_title (line 1522)

Changes the document title.

kt_response rename_document_title (string $session_id, int $document_id, string $newtitle)

string $session_id
int $document_id
string $newtitle

rename_folder (line 808)

Renames a folder.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_FOLDER or KTWS_SUCCESS

kt_response. rename_folder (string $session_id, int $folder_id, string $newname)

string $session_id
int $folder_id
string $newname

start_document_workflow (line 1637)

Start a workflow on a document

kt_response start_document_workflow (string $session_id, int $document_id, string $workflow)

string $session_id
int $document_id
string $workflow

undo_document_checkout (line 1260)

Undoes a document checkout.

return: status_code can be KTWS_ERR_INVALID_SESSION, KTWS_ERR_INVALID_DOCUMENT or KTWS_SUCCESS

kt_response. undo_document_checkout (string $session_id, int $document_id, string $reason)

string $session_id
int $document_id
string $reason

update_document_metadata (line 1810)

Updates document metadata.

kt_response update_document_metadata (string $session_id, int $document_id, array $metadata)

string $session_id
int $document_id
array $metadata

__dispatch (line 2036)

void __dispatch ( $methodname)

$methodname

Documentation generated on Sun, 22 Apr 2007 02:31:06 +0200 by phpDocumentor 1.3.2