Docs For Class KTWSAPI

Description

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

Variable Summary

mixed $download_path

mixed $session

SOAP_Client $soapclient

mixed $timeout

mixed $wsdl

Method Summary

KTWSAPI KTWSAPI ([string $wsdl = KTWebService_WSDL], [int $timeout = 30])

string active_session (string $session, [string $ip = null])

KTWSAPI_Document &get_document_by_id (int $documentid)

string get_download_path ()

KTWSAPI_Folder &get_folder_by_id ( $folderid)

KTWSAPI_Folder &get_root_folder ()

true logout ()

true set_download_path (string $download_path)

string start_anonymous_session ([string $ip = null])

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

Variables

mixed $download_path (line 1123)

mixed $session (line 1122)

SOAP_Client $soapclient (line 1120)

Enter description here...

mixed $timeout (line 1121)

mixed $wsdl (line 1114)

Methods

Constructor KTWSAPI (line 1132)

Constructor

KTWSAPI KTWSAPI ([string $wsdl = KTWebService_WSDL], [int $timeout = 30])

string $wsdl
int $timeout

active_session (line 1222)

Sets an active session.

string active_session (string $session, [string $ip = null])

string $session
string $ip

get_document_by_id (line 1287)

Returns a reference to a document based on id.

KTWSAPI_Document &get_document_by_id (int $documentid)

int $documentid

get_download_path (line 1146)

This returns the default location where documents are downloaded in download() and checkout().

string get_download_path ()

get_folder_by_id (line 1271)

Returns a reference to a folder based on id.

KTWSAPI_Folder &get_folder_by_id ( $folderid)

$folderid

get_root_folder (line 1261)

Returns a reference to the root folder.

KTWSAPI_Folder &get_root_folder ()

logout (line 1238)

Closes an active session.

true logout ()

set_download_path (line 1157)

Allows the default location for downloaded documents to be changed.

true set_download_path (string $download_path)

string $download_path

start_anonymous_session (line 1178)

Starts an anonymous session.

string start_anonymous_session ([string $ip = null])

string $ip

start_session (line 1191)

Starts a user session.

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

string $username
string $password
string $ip