This is the constructor for the KTAPI_Folder.
-
KTAPI
$ktapi
-
Folder
$folder
-
&$ktapi
-
&$folder
This adds a document to the current folder.
KTAPI_Document
&add_document
(
string $title,
string $filename,
string $documenttype,
string $tempfilename)
-
string
$title: This is the title for the file in the repository.
-
string
$filename: This is the filename in the system for the file.
-
string
$documenttype: This is the name or id of the document type. It first looks by name, then by id.
-
string
$tempfilename: This is a reference to the file that is accessible locally on the file system.
This adds a subfolder folder to the current folder.
This copies a folder to another location.
true
copy
(
KTAPI_Folder $ktapi_target_folder, [
string $reason =
''])
This deletes the current folder.
true
delete
(string $reason)
This is used to get a folder based on a folder id.
-
KTAPI
$ktapi
-
int
$folderid
-
&$ktapi
This returns detailed information on the document.
array
get_detail
()
This can resolve a document relative to the current directy by filename .
This can resolve a document relative to the current directy by name.
This returns a reference to the internal folder object.
Folder
&get_folder
()
This returns the folderid.
int
get_folderid
()
This can resolve a folder relative to the current directy by name
void
get_listing
([ $depth = 1], [ $what = 'DF'])
void
get_parent_folder_id
()
This returns all permissions linked to the folder.
array
get_permissions
()
This returns a transaction history listing.
array
get_transaction_history
()
This moves the folder to another location.
true
move
(
KTAPI_Folder $ktapi_target_folder, [
string $reason =
''])
This renames the folder
true
rename
(string $newname)
This gets a document by filename or name.
KTAPI_Document
&_get_document_by_name
(
string $documentname, [
string $function =
'getByNameAndFolder'])
-
string
$documentname
-
string
$function
Inherited Methods
Inherited From KTAPI_FolderItem
KTAPI_FolderItem::can_user_access_object_requiring_permission()