[KTAPI] element index

Package indexes

All elements

top

_get_document_by_name: KTAPI_Folder::_get_document_by_name() in ktapi.inc.php

This gets a document by filename or name.
_load_metadata_tree: KTAPI::_load_metadata_tree() in ktapi.inc.php

This returns a metadata tree.

top

add_document: KTAPI_Folder::add_document() in ktapi.inc.php

This adds a document to the current folder.
add_folder: KTAPI_Folder::add_folder() in ktapi.inc.php

This adds a subfolder folder to the current folder.
archive: KTAPI_Document::archive() in ktapi.inc.php

This flags the document as 'archived'.

top

can_user_access_object_requiring_permission: KTAPI_FolderItem::can_user_access_object_requiring_permission() in ktapi.inc.php
can_user_access_object_requiring_permission: KTAPI::can_user_access_object_requiring_permission() in ktapi.inc.php

This checks if a user can access an object with a certain permission.
change_document_type: KTAPI_Document::change_document_type() in ktapi.inc.php

This changes the document type of the document.
change_owner: KTAPI_Document::change_owner() in ktapi.inc.php

This changes the owner of the file.
checkin: KTAPI_Document::checkin() in ktapi.inc.php

This checks a document into the repository
checkout: KTAPI_Document::checkout() in ktapi.inc.php

This returns a URL to the file that can be downloaded.
copy: KTAPI_Folder::copy() in ktapi.inc.php

This copies a folder to another location.
copy: KTAPI_Document::copy() in ktapi.inc.php

This copies the document to another folder.

top

$document: KTAPI_Document::$document in ktapi.inc.php

This is a reference to the internal document object.
$documentid: KTAPI_Document::$documentid in ktapi.inc.php

This is the id of the document.
delete: KTAPI_Folder::delete() in ktapi.inc.php

This deletes the current folder.
delete: KTAPI_Document::delete() in ktapi.inc.php

This deletes a document from the folder.
delete_workflow: KTAPI_Document::delete_workflow() in ktapi.inc.php

This deletes the workflow on the document.
download: KTAPI_Document::download() in ktapi.inc.php

This does a download of a version of the document.

top

expunge: KTAPI_Document::expunge() in ktapi.inc.php

This expunges a document from the system.

top

$folder: KTAPI_Folder::$folder in ktapi.inc.php

This is a reference to a base Folder object.
$folderid: KTAPI_Folder::$folderid in ktapi.inc.php

This is the id of the folder on the database.

top

get: KTAPI_Folder::get() in ktapi.inc.php

This is used to get a folder based on a folder id.
get: KTAPI_Document::get() in ktapi.inc.php

This is used to get a document based on document id.
get_active_session: KTAPI_Session::get_active_session() in ktapi.inc.php

This returns an active session.
get_active_session: KTAPI::get_active_session() in ktapi.inc.php

This returns a session object based on a session string.
get_detail: KTAPI_Folder::get_detail() in ktapi.inc.php

This returns detailed information on the document.
get_detail: KTAPI_Document::get_detail() in ktapi.inc.php

This returns detailed information on the document.
get_documenttypeid: KTAPI::get_documenttypeid() in ktapi.inc.php

This returns a document type id based on the name.
get_documenttypes: KTAPI::get_documenttypes() in ktapi.inc.php

Returns an array of document types.
get_document_by_filename: KTAPI_Folder::get_document_by_filename() in ktapi.inc.php

This can resolve a document relative to the current directy by filename .
get_document_by_id: KTAPI::get_document_by_id() in ktapi.inc.php

This returns a refererence to a document based on document id.
get_document_by_name: KTAPI_Folder::get_document_by_name() in ktapi.inc.php

This can resolve a document relative to the current directy by name.
get_folder: KTAPI_Folder::get_folder() in ktapi.inc.php

This returns a reference to the internal folder object.
get_folderid: KTAPI_Folder::get_folderid() in ktapi.inc.php

This returns the folderid.
get_folder_by_id: KTAPI::get_folder_by_id() in ktapi.inc.php

Obtains the folder using a folder id.
get_folder_by_name: KTAPI_Folder::get_folder_by_name() in ktapi.inc.php

This can resolve a folder relative to the current directy by name
get_folder_name: KTAPI_Folder::get_folder_name() in ktapi.inc.php
get_full_path: KTAPI_Folder::get_full_path() in ktapi.inc.php
get_listing: KTAPI_Folder::get_listing() in ktapi.inc.php
get_metadata: KTAPI_Document::get_metadata() in ktapi.inc.php

This returns all metadata for the document.
get_metadata_lookup: KTAPI::get_metadata_lookup() in ktapi.inc.php

This returns an array for a lookup.
get_metadata_tree: KTAPI::get_metadata_tree() in ktapi.inc.php

This returns a metadata tree.
get_parent_folder_id: KTAPI_Folder::get_parent_folder_id() in ktapi.inc.php
get_permission: KTAPI::get_permission() in ktapi.inc.php

This returns a permission.
get_permissions: KTAPI_Folder::get_permissions() in ktapi.inc.php

This returns all permissions linked to the folder.
get_root_folder: KTAPI::get_root_folder() in ktapi.inc.php

Obtains the root folder.
get_session: KTAPI_Session::get_session() in ktapi.inc.php

This returns the session string
get_session: KTAPI::get_session() in ktapi.inc.php

This returns the current session.
get_sessionid: KTAPI_Session::get_sessionid() in ktapi.inc.php

This returns the sessionid in the database.
get_title: KTAPI_Document::get_title() in ktapi.inc.php
get_transaction_history: KTAPI_Document::get_transaction_history() in ktapi.inc.php

This returns the transaction history for the document.
get_transaction_history: KTAPI_Folder::get_transaction_history() in ktapi.inc.php

This returns a transaction history listing.
get_user: KTAPI::get_user() in ktapi.inc.php

This returns the session user.
get_user: KTAPI_Session::get_user() in ktapi.inc.php

This returns a user object for the use rassociated with the session.
get_users: KTAPI::get_users() in ktapi.inc.php

Returns an array of username/name combinations.
get_version_history: KTAPI_Document::get_version_history() in ktapi.inc.php

This returns the version history on the document.
get_workflows: KTAPI::get_workflows() in ktapi.inc.php

Returns a list of workflows that are active.
get_workflow_state: KTAPI_Document::get_workflow_state() in ktapi.inc.php

This returns the current workflow state
get_workflow_transitions: KTAPI_Document::get_workflow_transitions() in ktapi.inc.php

This returns a workflow transition

top

$ip: KTAPI_Session::$ip in ktapi.inc.php

top

$ktapi: KTAPI_FolderItem::$ktapi in ktapi.inc.php

This is a reference to the core KTAPI controller
$ktapi: KTAPI_Session::$ktapi in ktapi.inc.php
$ktapi_folder: KTAPI_Document::$ktapi_folder in ktapi.inc.php

This is a reference to the parent folder.
KTAPI: KTAPI in ktapi.inc.php
ktapi.inc.php: ktapi.inc.php in ktapi.inc.php
KTAPI_Document: KTAPI_Document in ktapi.inc.php
KTAPI_Document: KTAPI_Document::KTAPI_Document() in ktapi.inc.php

This is the constructor for the KTAPI_Folder.
KTAPI_ERROR_DOCUMENT_CHECKED_OUT: KTAPI_ERROR_DOCUMENT_CHECKED_OUT in ktapi.inc.php
KTAPI_ERROR_DOCUMENT_INVALID: KTAPI_ERROR_DOCUMENT_INVALID in ktapi.inc.php
KTAPI_ERROR_DOCUMENT_NOT_CHECKED_OUT: KTAPI_ERROR_DOCUMENT_NOT_CHECKED_OUT in ktapi.inc.php
KTAPI_ERROR_DOCUMENT_TYPE_INVALID: KTAPI_ERROR_DOCUMENT_TYPE_INVALID in ktapi.inc.php
KTAPI_ERROR_FOLDER_INVALID: KTAPI_ERROR_FOLDER_INVALID in ktapi.inc.php
KTAPI_ERROR_INSUFFICIENT_PERMISSIONS: KTAPI_ERROR_INSUFFICIENT_PERMISSIONS in ktapi.inc.php
KTAPI_ERROR_INTERNAL_ERROR: KTAPI_ERROR_INTERNAL_ERROR in ktapi.inc.php
KTAPI_ERROR_KTAPI_INVALID: KTAPI_ERROR_KTAPI_INVALID in ktapi.inc.php
KTAPI_ERROR_PERMISSION_INVALID: KTAPI_ERROR_PERMISSION_INVALID in ktapi.inc.php
KTAPI_ERROR_SESSION_INVALID: KTAPI_ERROR_SESSION_INVALID in ktapi.inc.php
KTAPI_ERROR_USER_INVALID: KTAPI_ERROR_USER_INVALID in ktapi.inc.php
KTAPI_ERROR_WORKFLOW_INVALID: KTAPI_ERROR_WORKFLOW_INVALID in ktapi.inc.php
KTAPI_ERROR_WORKFLOW_NOT_IN_PROGRESS: KTAPI_ERROR_WORKFLOW_NOT_IN_PROGRESS in ktapi.inc.php
KTAPI_Folder: KTAPI_Folder in ktapi.inc.php
KTAPI_Folder: KTAPI_Folder::KTAPI_Folder() in ktapi.inc.php

This is the constructor for the KTAPI_Folder.
KTAPI_FolderItem: KTAPI_FolderItem in ktapi.inc.php
KTAPI_PERMISSION_ADD_FOLDER: KTAPI_PERMISSION_ADD_FOLDER in ktapi.inc.php
KTAPI_PERMISSION_CHANGE_OWNERSHIP: KTAPI_PERMISSION_CHANGE_OWNERSHIP in ktapi.inc.php
KTAPI_PERMISSION_DELETE: KTAPI_PERMISSION_DELETE in ktapi.inc.php
KTAPI_PERMISSION_DOCUMENT_MOVE: KTAPI_PERMISSION_DOCUMENT_MOVE in ktapi.inc.php
KTAPI_PERMISSION_READ: KTAPI_PERMISSION_READ in ktapi.inc.php
KTAPI_PERMISSION_RENAME_FOLDER: KTAPI_PERMISSION_RENAME_FOLDER in ktapi.inc.php
KTAPI_PERMISSION_WORKFLOW: KTAPI_PERMISSION_WORKFLOW in ktapi.inc.php
KTAPI_PERMISSION_WRITE: KTAPI_PERMISSION_WRITE in ktapi.inc.php
KTAPI_Session: KTAPI_Session::KTAPI_Session() in ktapi.inc.php
KTAPI_Session: KTAPI_Session in ktapi.inc.php

top

logout: KTAPI_Session::logout() in ktapi.inc.php

This closes the current session.

top

move: KTAPI_Folder::move() in ktapi.inc.php

This moves the folder to another location.
move: KTAPI_Document::move() in ktapi.inc.php

This moves the document to another folder.

top

perform_workflow_transition: KTAPI_Document::perform_workflow_transition() in ktapi.inc.php

This performs a transition on the workflow

top

rename: KTAPI_Folder::rename() in ktapi.inc.php

This renames the folder
rename: KTAPI_Document::rename() in ktapi.inc.php

This changes the title of the document.
renameFile: KTAPI_Document::renameFile() in ktapi.inc.php

This changes the filename of the document.
resolveIP: KTAPI_Session::resolveIP() in ktapi.inc.php

This resolves the user's ip
restore: KTAPI_Document::restore() in ktapi.inc.php

This expunges a document from the system.

top

$session: KTAPI::$session in ktapi.inc.php

This is the current session.
$session: KTAPI_Session::$session in ktapi.inc.php
$sessionid: KTAPI_Session::$sessionid in ktapi.inc.php
start_anonymous_session: KTAPI::start_anonymous_session() in ktapi.inc.php

Starts an anonymous session.
start_session: KTAPI::start_session() in ktapi.inc.php

This returns a session object based on authentication credentials.
start_session: KTAPI_Session::start_session() in ktapi.inc.php

This returns a session object based on authentication credentials.
start_workflow: KTAPI_Document::start_workflow() in ktapi.inc.php

This starts a workflow on a document.

top

$user: KTAPI_Session::$user in ktapi.inc.php
undo_checkout: KTAPI_Document::undo_checkout() in ktapi.inc.php

This reverses the checkout process.
update_metadata: KTAPI_Document::update_metadata() in ktapi.inc.php

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