- Publicity: Public Only All
ckfinder-procs.tcl
CKEditor 5 helper for ckfinder interface (not complete) This script defines the following public procs: ::richtext::ckeditor5::ckfinder::image_attach ::richtext::ckeditor5::ckfinder::return_file
- Location:
- packages/richtext-ckeditor5/tcl/ckfinder-procs.tcl
- Created:
- 15 Aug 2017
- Author:
- Gustaf Neumann
- CVS Identification:
$Id: ckfinder-procs.tcl,v 1.2 2018/06/29 17:46:00 hectorr Exp $ NOTE: the delivery of files performs two permission checks, once in the requestprocessor (the site nodes) and once for the concrete image. If one whishes to make uploaded images readable by "The Public", make sure that the /
Procedures in this file
- richtext::ckeditor5::ckfinder::file_attach (public)
- richtext::ckeditor5::ckfinder::query_page_contract (private)
- richtext::ckeditor5::ckfinder::require_root_folder (private)
- richtext::ckeditor5::ckfinder::return_file (public)
Detailed information
richtext::ckeditor5::ckfinder::file_attach (public)
richtext::ckeditor5::ckfinder::file_attach \
[ -import_file import_file ] [ -mime_type mime_type ] \
[ -object_id object_id ] [ -privilege privilege ] \
[ -user_id user_id ] [ -peeraddr peeraddr ] \
[ -package_id package_id ] [ -image ]Insert the provided image file to the content repository as a new item and attach the image to the specified object_id via the attachment API. This makes sure that the image will be deleted from the content repository, when the provided object_id is deleted. The user must have at least "read" privileges on the object, but other stronger privileges can be supplied via parameter.
- Switches:
- -import_file
(optional)- -mime_type
(optional)- -object_id
(optional)- -privilege
(defaults to"read") (optional)- -user_id
(optional)- -peeraddr
(optional)- -package_id
(optional)- -image
(boolean) (optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::ckeditor5::ckfinder::query_page_contract (private)
richtext::ckeditor5::ckfinder::query_page_contract [ -level level ] \
paramsHelper function similar to ad_page_contract, but works only on query variables.
- Switches:
- -level
(defaults to"1") (optional)- Parameters:
- params
- Returns:
- list of complaints, which is empty in case of success
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::ckeditor5::ckfinder::require_root_folder (private)
richtext::ckeditor5::ckfinder::require_root_folder \
[ -parent_id parent_id ] [ -name name ]Helper function to find the root folder for ckfinder attachments.
- Switches:
- -parent_id
(defaults to"-100") (optional)- -name
(defaults to"attachments") (optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
richtext::ckeditor5::ckfinder::return_file (public)
richtext::ckeditor5::ckfinder::return_file \
[ -revision_id revision_id ] [ -user_id user_id ]Return the file with the specified revision_id to the user. The user must have at read permissions to obtain the file (image).
- Switches:
- -revision_id
(optional)- -user_id
(optional)- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
