Docs For Class KTWSAPI

Description

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

KTWSAPI_FolderItem
   |
   --KTWSAPI_Folder

Variable Summary

mixed $folder_id

mixed $folder_name

mixed $full_path

Method Summary

KTWSAPI_Folder KTWSAPI_Folder ( &$ktapi, kt_folder_detail $kt_folder_detail, KTWSAPI $ktapi)

KTWSAPI_Document &add_document (string $filename, [string $title = null], [string $documenttype = null])

KTWSAPI_Folder &add_folder (string $foldername)

true copy ( &$ktwsapi_target_folder, [string $reason = ''], KTWSAPI_Folder $ktwsapi_target_folder)

true delete (string $reason)

KTWSAPI_Folder &get ( &$ktapi, int $folderid, KTWSAPI $ktapi)

KTWSAPI_Document &get_document_by_filename (string $filename)

KTWSAPI_Document &get_document_by_name (string $title)

int get_folderid ()

KTWSAPI_Folder &get_folder_by_name (string $foldername)

string get_folder_name ()

string get_full_path ()

kt_folder_items get_listing ([int $depth = 1], [string $what = 'DF'])

int get_parent_folder_id ()

true move ( &$ktwsapi_target_folder, [string $reason = ''], KTWSAPI_Folder $ktwsapi_target_folder)

true rename (string $newname)

Variables

mixed $folder_id (line 184)

mixed $folder_name (line 182)

mixed $full_path (line 183)

Inherited Variables

Inherited from KTWSAPI_FolderItem

KTWSAPI_FolderItem::$ktapi
KTWSAPI_FolderItem::$parent_id

Methods

Constructor KTWSAPI_Folder (line 193)

Constructor

KTWSAPI_Folder KTWSAPI_Folder ( &$ktapi, kt_folder_detail $kt_folder_detail, KTWSAPI $ktapi)

KTWSAPI $ktapi
kt_folder_detail $kt_folder_detail
&$ktapi

add_document (line 531)

Adds a document to the current folder.

KTWSAPI_Document &add_document (string $filename, [string $title = null], [string $documenttype = null])

string $filename
string $title
string $documenttype

add_folder (line 406)

Adds a sub folder.

KTWSAPI_Folder &add_folder (string $foldername)

string $foldername

copy (line 502)

Copies a folder to another location

true copy ( &$ktwsapi_target_folder, [string $reason = ''], KTWSAPI_Folder $ktwsapi_target_folder)

KTWSAPI_Folder $ktwsapi_target_folder
string $reason
&$ktwsapi_target_folder

delete (line 430)

Deletes the current folder.

true delete (string $reason)

string $reason

get (line 209)

Returns a reference to a KTWSAPI_Folder

KTWSAPI_Folder &get ( &$ktapi, int $folderid, KTWSAPI $ktapi)

KTWSAPI $ktapi
int $folderid
&$ktapi

get_document_by_filename (line 371)

Returns a document based on filename.

KTWSAPI_Document &get_document_by_filename (string $filename)

string $filename

get_document_by_name (line 336)

Returns a document based on title.

KTWSAPI_Document &get_document_by_name (string $title)

string $title

get_folderid (line 258)

Returns the current folder id.

int get_folderid ()

get_folder_by_name (line 269)

Returns the foldre based on foldername.

KTWSAPI_Folder &get_folder_by_name (string $foldername)

string $foldername

get_folder_name (line 248)

Returns the folder name.

string get_folder_name ()

get_full_path (line 302)

Returns the full folder path.

string get_full_path ()

get_listing (line 314)

Returns the contents of a folder.

kt_folder_items get_listing ([int $depth = 1], [string $what = 'DF'])

int $depth
string $what

get_parent_folder_id (line 238)

Returnss the parent folder id.

int get_parent_folder_id ()

move (line 476)

Moves a folder to another location.

true move ( &$ktwsapi_target_folder, [string $reason = ''], KTWSAPI_Folder $ktwsapi_target_folder)

KTWSAPI_Folder $ktwsapi_target_folder
string $reason
&$ktwsapi_target_folder

rename (line 453)

Renames the current folder.

true rename (string $newname)

string $newname

Inherited Methods

Inherited From KTWSAPI_FolderItem

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

Class KTWSAPI_Folder

Inherited Variables

Inherited Methods