Docs For Class KTAPI

Class KTAPI_Document

Description

Located in /ktapi/ktapi.inc.php (line 916)

KTAPI_FolderItem
   |
   --KTAPI_Document

Variable Summary

Document $document

int $documentid

KTAPI_Folder $ktapi_folder

Method Summary

static KTAPI_Document &get ( &$ktapi, int $documentid, KTAPI $ktapi)

KTAPI_Document KTAPI_Document ( &$ktapi, &$ktapi_folder, &$document, KTAPI $ktapi, Document $document)

true archive (string $reason)

true change_document_type ( $documenttype, string $newname)

true change_owner ( $newusername, [ $reason = 'Changing of owner.'], string $ktapi_newuser)

true checkin (string $filename, string $reason, string $tempfilename, [bool $major_update = false])

true; checkout (string $reason)

true copy ( &$ktapi_target_folder, string $reason, [string $newname = null], [string $newfilename = null], KTAPI_Folder $ktapi_target_folder)

mixed delete (string $reason)

true delete_workflow ()

true download ([string $version = null])

mixed expunge ()

array get_detail ()

array get_metadata ()

void get_title ()

array get_transaction_history ()

array get_version_history ()

string get_workflow_state ()

array get_workflow_transitions ()

true move ( &$ktapi_target_folder, string $reason, [string $newname = null], [string $newfilename = null], KTAPI_Folder $ktapi_target_folder)

true perform_workflow_transition (string $transition, string $reason)

true rename (string $newname)

true renameFile (string $newname)

mixed restore ()

true start_workflow (string $workflow)

true undo_checkout (string $reason)

mixed update_metadata (array $metadata)

Variables

Document $document (line 923)

This is a reference to the internal document object.

int $documentid (line 929)

This is the id of the document.

KTAPI_Folder $ktapi_folder (line 935)

This is a reference to the parent folder.

Inherited Variables

Inherited from KTAPI_FolderItem

KTAPI_FolderItem::$ktapi

Methods

static method get (line 946)

This is used to get a document based on document id.

access: public

static KTAPI_Document &get ( &$ktapi, int $documentid, KTAPI $ktapi)

KTAPI $ktapi
int $documentid
&$ktapi

Constructor KTAPI_Document (line 983)

This is the constructor for the KTAPI_Folder.

access: private

KTAPI_Document KTAPI_Document ( &$ktapi, &$ktapi_folder, &$document, KTAPI $ktapi, Document $document)

KTAPI $ktapi
Document $document
&$ktapi
&$ktapi_folder
&$document

archive (line 1507)

This flags the document as 'archived'.

true archive (string $reason)

string $reason

change_document_type (line 1441)

This changes the document type of the document.

true change_document_type ( $documenttype, string $newname)

string $newname
$documenttype

change_owner (line 1156)

This changes the owner of the file.

true change_owner ( $newusername, [ $reason = 'Changing of owner.'], string $ktapi_newuser)

string $ktapi_newuser
$newusername
$reason

checkin (line 1003)

This checks a document into the repository

true checkin (string $filename, string $reason, string $tempfilename, [bool $major_update = false])

string $filename
string $reason
string $tempfilename
bool $major_update

checkout (line 1090)

This returns a URL to the file that can be downloaded.

true; checkout (string $reason)

string $reason

copy (line 1213)

This copies the document to another folder.

true copy ( &$ktapi_target_folder, string $reason, [string $newname = null], [string $newfilename = null], KTAPI_Folder $ktapi_target_folder)

KTAPI_Folder $ktapi_target_folder
string $reason
string $newname
string $newfilename
&$ktapi_target_folder

delete (line 1123)

This deletes a document from the folder.

return: This returns true or a PEAR::Error

mixed delete (string $reason)

string $reason

delete_workflow (line 1592)

This deletes the workflow on the document.

true delete_workflow ()

download (line 1967)

This does a download of a version of the document.

true download ([string $version = null])

string $version

expunge (line 2035)

This expunges a document from the system.

return: This returns true or a PEAR::Error
access: public

mixed expunge ()

get_detail (line 1862)

This returns detailed information on the document.

array get_detail ()

get_metadata (line 1666)

This returns all metadata for the document.

array get_metadata ()

get_title (line 1956)

void get_title ()

get_transaction_history (line 1984)

This returns the transaction history for the document.

array get_transaction_history ()

get_version_history (line 2006)

This returns the version history on the document.

array get_version_history ()

get_workflow_state (line 1828)

This returns the current workflow state

string get_workflow_state ()

get_workflow_transitions (line 1793)

This returns a workflow transition

array get_workflow_transitions ()

move (line 1318)

This moves the document to another folder.

true move ( &$ktapi_target_folder, string $reason, [string $newname = null], [string $newfilename = null], KTAPI_Folder $ktapi_target_folder)

KTAPI_Folder $ktapi_target_folder
string $reason
string $newname
string $newfilename
&$ktapi_target_folder

perform_workflow_transition (line 1626)

This performs a transition on the workflow

true perform_workflow_transition (string $transition, string $reason)

string $transition
string $reason

rename (line 1474)

This changes the title of the document.

true rename (string $newname)

string $newname

renameFile (line 1414)

This changes the filename of the document.

true renameFile (string $newname)

string $newname

restore (line 2063)

This expunges a document from the system.

return: This returns true or a PEAR::Error
access: public

mixed restore ()

start_workflow (line 1553)

This starts a workflow on a document.

true start_workflow (string $workflow)

string $workflow

undo_checkout (line 1048)

This reverses the checkout process.

true undo_checkout (string $reason)

string $reason

update_metadata (line 1740)

This updates the metadata on the file. This includes the 'title'.

return: This returns true or a PEAR::Error

mixed update_metadata (array $metadata)

array $metadata: This is an array containing the metadata to be associated with the file.

Inherited Methods

Inherited From KTAPI_FolderItem

KTAPI_FolderItem::can_user_access_object_requiring_permission()

Documentation generated on Sun, 22 Apr 2007 02:30:53 +0200 by phpDocumentor 1.3.2