Docs For Class KTWSAPI

Description

Located in /ktwsapi/php/ktwsapi.inc.php (line 568)

KTWSAPI_FolderItem
   |
   --KTWSAPI_Document

Variable Summary

mixed $checkout_by

mixed $created_by

mixed $created_date

mixed $document_id

mixed $document_type

mixed $filename

mixed $full_path

mixed $title

mixed $updated_by

mixed $updated_date

mixed $version

mixed $workflow

mixed $workflow_state

Method Summary

KTWSAPI_Document KTWSAPI_Document ( &$ktapi, kt_document_detail $kt_document_detail, KTWSAPI $ktapi)

true change_document_type (string $documenttype)

true change_owner (string $username, string $reason)

true checkin (string $filename, string $reason, boolean $major_update)

true checkout (string $reason, [string $localpath = null])

void copy ( &$folder, string $reason, [string $newtitle = ''], [string $newfilename = ''], KTWSAPI_Folder $folder)

true delete (string $reason)

true delete_workflow ()

true download ([string $version = null], [string $localpath = null])

KTWSAPI_Document &get ( &$ktapi, int $documentid, [boolean $loadinfo = true], KTWSAPI $ktapi)

kt_metadata_response get_metadata ()

kt_document_transaction_history get_transaction_history ()

$kt_document_version_history get_version_history ()

true move ( &$folder, string $reason, [string $newtitle = ''], [string $newfilename = ''], KTWSAPI_Folder $folder)

true perform_workflow_transition (string $transition, string $reason)

true rename_filename (string $newfilename)

true rename_title (string $newtitle)

true start_workflow (string $workflow)

true undo_checkout (string $reason)

true update_metadata (kt_metadata $metadata)

Variables

mixed $checkout_by (line 581)

mixed $created_by (line 576)

mixed $created_date (line 575)

mixed $document_id (line 570)

mixed $document_type (line 572)

mixed $filename (line 574)

mixed $full_path (line 582)

mixed $title (line 571)

mixed $updated_by (line 578)

mixed $updated_date (line 577)

mixed $version (line 573)

mixed $workflow (line 579)

mixed $workflow_state (line 580)

Inherited Variables

Inherited from KTWSAPI_FolderItem

KTWSAPI_FolderItem::$ktapi
KTWSAPI_FolderItem::$parent_id

Methods

Constructor KTWSAPI_Document (line 591)

Constructor

KTWSAPI_Document KTWSAPI_Document ( &$ktapi, kt_document_detail $kt_document_detail, KTWSAPI $ktapi)

KTWSAPI $ktapi
kt_document_detail $kt_document_detail
&$ktapi

change_document_type (line 900)

Changes the document type.

true change_document_type (string $documenttype)

string $documenttype

change_owner (line 821)

Changes the owner of the document.

true change_owner (string $username, string $reason)

string $username
string $reason

checkin (line 656)

Checks in a document.

true checkin (string $filename, string $reason, boolean $major_update)

string $filename
string $reason
boolean $major_update

checkout (line 687)

Checks out a document.

true checkout (string $reason, [string $localpath = null])

string $reason
string $localpath

copy (line 845)

Copies the document to the specified folder.

void copy ( &$folder, string $reason, [string $newtitle = ''], [string $newfilename = ''], KTWSAPI_Folder $folder)

KTWSAPI_Folder $folder
string $reason
string $newtitle
string $newfilename
&$folder

delete (line 798)

Deletes the current document.

true delete (string $reason)

string $reason

delete_workflow (line 987)

Removes the workflow process from the current document.

true delete_workflow ()

download (line 754)

Download a version of the document

true download ([string $version = null], [string $localpath = null])

string $version
string $localpath

get (line 618)

Returns a reference to a document.

KTWSAPI_Document &get ( &$ktapi, int $documentid, [boolean $loadinfo = true], KTWSAPI $ktapi)

KTWSAPI $ktapi
int $documentid
boolean $loadinfo
&$ktapi

get_metadata (line 1031)

Returns metadata on the document.

kt_metadata_response get_metadata ()

get_transaction_history (line 1074)

Returns the transaction history on the current document.

kt_document_transaction_history get_transaction_history ()

get_version_history (line 1095)

Returns the version history on the current document.

$kt_document_version_history get_version_history ()

move (line 874)

Moves the current folder to the specified folder.

true move ( &$folder, string $reason, [string $newtitle = ''], [string $newfilename = ''], KTWSAPI_Folder $folder)

KTWSAPI_Folder $folder
string $reason
string $newtitle
string $newfilename
&$folder

perform_workflow_transition (line 1010)

Performs a transition on the current document.

true perform_workflow_transition (string $transition, string $reason)

string $transition
string $reason

rename_filename (line 944)

Renames the filename of the current document.

true rename_filename (string $newfilename)

string $newfilename

rename_title (line 922)

Renames the title of the current document.

true rename_title (string $newtitle)

string $newtitle

start_workflow (line 966)

Starts a workflow on the current document.

true start_workflow (string $workflow)

string $workflow

undo_checkout (line 731)

Undo a document checkout

true undo_checkout (string $reason)

string $reason

update_metadata (line 1053)

Updates the metadata on the current document.

true update_metadata (kt_metadata $metadata)

kt_metadata $metadata

Inherited Methods

Inherited From KTWSAPI_FolderItem

KTWSAPI_FolderItem::get_parent_folder()
KTWSAPI_FolderItem::_download_file()
KTWSAPI_FolderItem::_upload_file()

Class KTWSAPI_Document

Inherited Variables

Inherited Methods