- Publicity: Public Only All
bookmarks-procs.tcl
TCL library for the bookmarks module. Credit for the ACS 3 version of this module goes to:
- Location:
- packages/bookmarks/tcl/bookmarks-procs.tcl
- Created:
- December 2000
- Authors:
- David Hill <dh@arsdigita.com>
- Aurelius Prochazka (aure@arsdigita.com) The upgrade of this module to ACS 4 was done by
- Peter Marklund <pmarklun@arsdigita.com>
- Ken Kennedy (kenzoid@io.com) in December 2000.
- CVS Identification:
$Id: bookmarks-procs.tcl,v 1.9 2014/04/18 06:49:49 gustafn Exp $
Procedures in this file
- bm_bookmark_private_p (public)
- bm_context_bar_args (public)
- bm_delete_permission_p (public)
- bm_folder_selection (public)
- bm_get_html_description (public)
- bm_get_html_keywords (public)
- bm_get_html_title (public)
- bm_get_root_folder_id (public)
- bm_handle_bookmark_double_click (public)
- bm_host_url (public)
- bm_initialize_in_closed_p (public)
- bm_repeat_string (public)
- bm_require_delete_permission (public)
- bm_update_bookmark_private_p (public)
- bm_user_can_write_in_some_folder_p (public)
Detailed information
bm_bookmark_private_p (public)
bm_bookmark_private_p bookmark_id
- Parameters:
- bookmark_id (required)
- Testcases:
- No testcase defined.
bm_context_bar_args (public)
bm_context_bar_args arg_list viewed_user_id
If viewed_user_id <> browsing_user_id we need to prefix the context bar args with an entry for bookmarks of the viewed user. If the arg_list is empty it is assumed that we are on the index page and that otherwise the page has been linked from the index page.
- Parameters:
- arg_list (required)
- viewed_user_id (required)
- Testcases:
- No testcase defined.
bm_delete_permission_p (public)
bm_delete_permission_p bookmark_id
Returns boolean value indicating if the browsing user may delete the bookmark.
- Parameters:
- bookmark_id (required)
- Testcases:
- No testcase defined.
bm_folder_selection (public)
bm_folder_selection user_id bookmark_id folder_p
This procedure is used to present a list of available folders to put bookmark or folder in.
- Parameters:
- user_id (required)
- bookmark_id (required)
- folder_p (required)
- Testcases:
- No testcase defined.
bm_get_html_description (public)
bm_get_html_description html_code
- Parameters:
- html_code (required)
- Testcases:
- No testcase defined.
bm_get_html_keywords (public)
bm_get_html_keywords html_code
- Parameters:
- html_code (required)
- Testcases:
- No testcase defined.
bm_get_html_title (public)
bm_get_html_title html_code
- Parameters:
- html_code (required)
- Testcases:
- No testcase defined.
bm_get_root_folder_id (public)
bm_get_root_folder_id package_id user_id
Returns the id of the bookmark root folder of a user in a package instance. This root folder is used for default access permissioning of a users bookmarks (bookmarks will inherit permissions).
- Parameters:
- package_id (required)
- user_id (required)
- Testcases:
- No testcase defined.
bm_handle_bookmark_double_click (public)
bm_handle_bookmark_double_click bookmark_id errmsg return_url
- Parameters:
- bookmark_id (required)
- errmsg (required)
- return_url (required)
- Testcases:
- No testcase defined.
bm_host_url (public)
bm_host_url complete_url
Takes a URL and returns the host portion of it (i.e., http://hostname.com/), which always contains a trailing slash. Returns empty string if complete_url wasn't parseable.
- Parameters:
- complete_url (required)
- Testcases:
- No testcase defined.
bm_initialize_in_closed_p (public)
bm_initialize_in_closed_p viewed_user_id in_closed_p_id package_id
- Parameters:
- viewed_user_id (required)
- in_closed_p_id (required)
- package_id (required)
- Testcases:
- No testcase defined.
bm_repeat_string (public)
bm_repeat_string string iteration_number
- Parameters:
- string (required)
- iteration_number (required)
- Testcases:
- No testcase defined.
bm_require_delete_permission (public)
bm_require_delete_permission bookmark_id
This proc verifyes that the user may delete the bookmark/folder and all its contained bookmarks/folders.
- Parameters:
- bookmark_id (required)
- Testcases:
- No testcase defined.
bm_update_bookmark_private_p (public)
bm_update_bookmark_private_p bookmark_id private_p
- Parameters:
- bookmark_id (required)
- private_p (required)
- Testcases:
- No testcase defined.
bm_user_can_write_in_some_folder_p (public)
bm_user_can_write_in_some_folder_p viewed_user_id
Returns "t" if there is a folder that the browsing user can write in, and "f' otherwise.
- Parameters:
- viewed_user_id (required)
- Testcases:
- No testcase defined.
