Docs For Class KTAPI

Description

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

Variable Summary

KTAPI_Session $session

Method Summary

static int get_documenttypeid (string $documenttype)

static array get_documenttypes ()

static array get_metadata_lookup (int $fieldid)

static array get_metadata_tree (int $fieldid)

static KTPermission &get_permission (string $permission)

static array get_users ()

static array get_workflows ()

User can_user_access_object_requiring_permission ( &$object, string $permission, object $object)

KTAPI_Session &get_active_session (string $session, [ $ip = null])

KTAPI_Document &get_document_by_id (int $documentid)

KTAPI_Folder &get_folder_by_id (int $folderid)

KTAPI_Folder &get_root_folder ()

KTAPI_Session &get_session ()

User &get_user ()

KTAPI_Session &start_anonymous_session ([string $ip = null])

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

array _load_metadata_tree (int $fieldid, [int $parentid = 0])

Variables

KTAPI_Session $session = null (line 2105)

This is the current session.

access: private

Methods

static method get_documenttypeid (line 2307)

This returns a document type id based on the name.

access: public

static int get_documenttypeid (string $documenttype)

string $documenttype

static method get_documenttypes (line 2326)

Returns an array of document types.

access: public

static array get_documenttypes ()

static method get_metadata_lookup (line 2370)

This returns an array for a lookup.

access: public

static array get_metadata_lookup (int $fieldid)

int $fieldid

static method get_metadata_tree (line 2424)

This returns a metadata tree.

access: public

static array get_metadata_tree (int $fieldid)

int $fieldid

static method get_permission (line 2149)

This returns a permission.

access: public

static KTPermission &get_permission (string $permission)

string $permission

static method get_users (line 2351)

Returns an array of username/name combinations.

access: public

static array get_users ()

static method get_workflows (line 2436)

Returns a list of workflows that are active.

access: public

static array get_workflows ()

can_user_access_object_requiring_permission (line 2168)

This checks if a user can access an object with a certain permission.

access: public

User can_user_access_object_requiring_permission ( &$object, string $permission, object $object)

object $object
string $permission
&$object

get_active_session (line 2200)

This returns a session object based on a session string.

access: public

KTAPI_Session &get_active_session (string $session, [ $ip = null])

string $session
$ip

get_document_by_id (line 2294)

This returns a refererence to a document based on document id.

access: public

KTAPI_Document &get_document_by_id (int $documentid)

int $documentid

get_folder_by_id (line 2277)

Obtains the folder using a folder id.

access: public

KTAPI_Folder &get_folder_by_id (int $folderid)

int $folderid

get_root_folder (line 2265)

Obtains the root folder.

access: public

KTAPI_Folder &get_root_folder ()

get_session (line 2113)

This returns the current session.

access: public

KTAPI_Session &get_session ()

get_user (line 2124)

This returns the session user.

access: public

User &get_user ()

start_anonymous_session (line 2253)

Starts an anonymous session.

KTAPI_Session &start_anonymous_session ([string $ip = null])

string $ip

start_session (line 2226)

This returns a session object based on authentication credentials.

access: public

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

string $username
string $password
$ip

_load_metadata_tree (line 2394)

This returns a metadata tree.

access: private

array _load_metadata_tree (int $fieldid, [int $parentid = 0])

int $fieldid
int $parentid