| Publicity: |
|---|
| [Public Only | All] |
Procs for the site-wide categorization package.
- Location:
- packages/categories/tcl/categories-procs.tcl
- Created:
- 16 April 2003
- Author:
- Timo Hentschel <timo@timohentschel.de>
- CVS Identification:
$Id: categories-procs.tcl,v 1.27 2008/12/21 18:05:35 gustafn Exp $
category::add (public)category::add [ -category_id category_id ] -tree_id tree_id \
-parent_id parent_id -name name [ -locale locale ] \
[ -description description ] [ -deprecated_p deprecated_p ] \
[ -user_id user_id ] [ -creation_ip creation_ip ] [ -noflush ]
Insert a new category. The same translation will be added in the default language if it's in a different language. |
category::change_parent (public)category::change_parent -category_id category_id -tree_id tree_id \
[ -parent_id parent_id ]
Changes parent category of a category. |
category::count_children (public)category::count_children -category_id category_id counts all direct sub categories |
category::delete (public)category::delete [ -batch_mode ] category_id Deletes a category. category_tree::flush_cache should be used afterwards. |
category::flush_translation_cache (public)category::flush_translation_cache category_id Flushes category translation cache of one category. |
category::get_children (public)category::get_children -category_id category_id Returns the category ids of the direct children of the given category |
category::get_data (public)category::get_data category_id [ locale ] Gets the category name and the tree name in the specified language, if available. Use default language otherwise. |
category::get_id (public)category::get_id name [ locale ] Gets the id of a category given a name. |
category::get_id_by_object_title (public)category::get_id_by_object_title title Gets the id of a category given an object title (object_type=category). This is highly useful as the category object title will not change if you change the name (label) of the category, so you can access the category even if the label has changed |
category::get_mapped_categories (public)category::get_mapped_categories [ -tree_id tree_id ] object_id Gets the list of categories mapped to an object. If tree_id is provided return only the categories mapped from the given tree. |
category::get_mapped_categories_multirow (public)category::get_mapped_categories_multirow [ -locale locale ] \
[ -multirow multirow ] object_id
Returns multirow with: tree_id, tree_name, category_id, category_name |
category::get_name (public)category::get_name category_id [ locale ] Gets the category name in the specified language, if available. Use default language otherwise. |
category::get_names (public)category::get_names category_ids [ locale ] Gets the category name in the specified language, if available. Use default language otherwise. |
category::get_object_context (public)category::get_object_context object_id Returns the object name and url to be used in a context bar. |
category::get_objects (public)category::get_objects [ -category_id category_id ] \
[ -object_type object_type ] [ -content_type content_type ] \
[ -include_children ]
Returns a list of objects which are mapped to this category_id |
category::get_parent (public)category::get_parent -category_id category_id Returns the category id of the parent category |
category::get_tree (public)category::get_tree category_id Gets the tree_id of the given category. |
category::indent_html (public)category::indent_html indent_width Deprecated. |
category::map_object (public)category::map_object [ -remove_old ] -object_id object_id \
category_id_list
Map an object to several categories. |
category::pageurl (public)category::pageurl object_id Returns the page that displays a category. To be used by the AcsObject.PageUrl service contract. |
category::phase_in (public)category::phase_in category_id Marks a category to be visible for categorizing new objects / update existing objects. Make sure to use category_tree::flush_cache afterwards. |
category::phase_out (public)category::phase_out category_id Marks a category to be phasing out. That means this category and all its subcategories will no longer appear in the categorization widget to categorize new objects / update existing objects, but all existing categorizations will still remain valid. Make sure to use category_tree::flush_cache afterwards. |
category::reset_translation_cache (public)category::reset_translation_cache Reloads all category translations in the cache. |
category::update (public)category::update -category_id category_id -name name \
[ -locale locale ] [ -description description ] \
[ -user_id user_id ] [ -modifying_ip modifying_ip ]
Updates/inserts a category translation. |