categories-procs.tcl

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.38.2.14 2022/09/08 15:56:46 antoniop Exp $

Procedures in this file

Detailed information

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.

Switches:
-category_id
(optional)
-tree_id
(required)
-parent_id
(required)
-name
(required)
-locale
(optional)
-description
(optional)
-deprecated_p
(defaults to "f") (optional)
-user_id
(optional)
-creation_ip
(optional)
-noflush
(boolean) (optional)
Options:
-category_id
category_id of the category to be inserted.
-locale
locale of the language. [ad_conn locale] used by default.
-name
category name.
-description
description of the category.
-deprecated_p
is category deprecated?
-tree_id
tree_id of the category the category should be added.
-parent_id
id of the parent category. "" if top level category.
-user_id
user that adds the category. [ad_conn user_id] used by default.
-creation_ip
ip-address of the user that adds the category. [ad_conn peeraddr] used by default.
-noflush
defer calling category_tree::flush_cache (which if adding multiple categories to a large tree can be very expensive). note that if you set this flag you must call category_tree::flush_cache once the adds are complete.
Returns:
category_id
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::add category::add test_category_crud->category::add test_category_get_procs category_get_procs (test categories) test_category_get_procs->category::add test_category_link category_link (test categories) test_category_link->category::add test_category_synonyms category_synonyms (test categories) test_category_synonyms->category::add test_category_tree_procs category_tree_procs (test categories) test_category_tree_procs->category::add ad_conn ad_conn (public) category::add->ad_conn category_tree::flush_cache category_tree::flush_cache (public) category::add->category_tree::flush_cache db_exec_plsql db_exec_plsql (public) category::add->db_exec_plsql db_transaction db_transaction (public) category::add->db_transaction parameter::get parameter::get (public) category::add->parameter::get category_tree::import category_tree::import (public) category_tree::import->category::add category_tree::xml::add_category category_tree::xml::add_category (private) category_tree::xml::add_category->category::add packages/categories/www/cadmin/category-form.tcl packages/categories/ www/cadmin/category-form.tcl packages/categories/www/cadmin/category-form.tcl->category::add

Testcases:
category_synonyms, category_link, category_crud, category_get_procs, category_tree_procs

category::after_install (private)

 category::after_install

Callback to be called after package installation. Adds the service contract implementations.

Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 acs_sc::impl::alias::new acs_sc::impl::alias::new (public) acs_sc::impl::binding::new acs_sc::impl::binding::new (public) acs_sc::impl::new acs_sc::impl::new (public) category::after_install category::after_install category::after_install->acs_sc::impl::alias::new category::after_install->acs_sc::impl::binding::new category::after_install->acs_sc::impl::new

Testcases:
No testcase defined.

category::before_uninstall (private)

 category::before_uninstall

Callback to be called before package uninstallation. Removes the service contract implementations.

Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 acs_sc::impl::delete acs_sc::impl::delete (public) category::before_uninstall category::before_uninstall category::before_uninstall->acs_sc::impl::delete

Testcases:
No testcase defined.

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.

Switches:
-category_id
(required)
-tree_id
(required)
-parent_id
(optional)
Options:
-category_id
category_id whose parent should change.
-tree_id
tree_id of the category tree.
-parent_id
new parent category_id.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_tree_procs category_tree_procs (test categories) category::change_parent category::change_parent test_category_tree_procs->category::change_parent category_tree::flush_cache category_tree::flush_cache (public) category::change_parent->category_tree::flush_cache db_exec_plsql db_exec_plsql (public) category::change_parent->db_exec_plsql packages/categories/www/cadmin/category-parent-change-2.tcl packages/categories/ www/cadmin/category-parent-change-2.tcl packages/categories/www/cadmin/category-parent-change-2.tcl->category::change_parent

Testcases:
category_tree_procs

category::context_bar (private)

 category::context_bar tree_id locale object_id [ ctx_id ]

Creates the standard context bar

Parameters:
tree_id
locale
object_id
ctx_id (optional)
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 packages/categories/www/cadmin/category-delete.tcl packages/categories/ www/cadmin/category-delete.tcl category::context_bar category::context_bar packages/categories/www/cadmin/category-delete.tcl->category::context_bar packages/categories/www/cadmin/category-form.tcl packages/categories/ www/cadmin/category-form.tcl packages/categories/www/cadmin/category-form.tcl->category::context_bar packages/categories/www/cadmin/category-link-add-2.tcl packages/categories/ www/cadmin/category-link-add-2.tcl packages/categories/www/cadmin/category-link-add-2.tcl->category::context_bar packages/categories/www/cadmin/category-link-add.tcl packages/categories/ www/cadmin/category-link-add.tcl packages/categories/www/cadmin/category-link-add.tcl->category::context_bar packages/categories/www/cadmin/category-link-delete.tcl packages/categories/ www/cadmin/category-link-delete.tcl packages/categories/www/cadmin/category-link-delete.tcl->category::context_bar _ _ (public) category::context_bar->_ category::get_object_context category::get_object_context (public) category::context_bar->category::get_object_context category_tree::get_name category_tree::get_name (public) category::context_bar->category_tree::get_name export_vars export_vars (public) category::context_bar->export_vars

Testcases:
No testcase defined.

category::count_children (public)

 category::count_children -category_id category_id

counts all direct sub categories

Switches:
-category_id
(required)

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_tree_procs category_tree_procs (test categories) category::count_children category::count_children test_category_tree_procs->category::count_children db_string db_string (public) category::count_children->db_string

Testcases:
category_tree_procs

category::delete (public)

 category::delete [ -batch_mode ] category_id

Deletes a category. category_tree::flush_cache should be used afterwards.

Switches:
-batch_mode
(boolean) (optional)
Parameters:
category_id - category_id of the category to be deleted.
Options:
-batch_mode
Indicates that the cache for category translations should not be flushed. Useful when deleting several categories at once. Don't forget to call reset_translation_cache
Author:
Timo Hentschel <timo@timohentschel.de>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::delete category::delete test_category_crud->category::delete category::flush_translation_cache category::flush_translation_cache (public) category::delete->category::flush_translation_cache db_exec_plsql db_exec_plsql (public) category::delete->db_exec_plsql category::map_object category::map_object (public) category::map_object->category::delete packages/categories/www/cadmin/category-delete-2.tcl packages/categories/ www/cadmin/category-delete-2.tcl packages/categories/www/cadmin/category-delete-2.tcl->category::delete

Testcases:
category_crud

category::flush_translation_cache (public)

 category::flush_translation_cache category_id

Flushes category translation cache of one category.

Parameters:
category_id - category to be flushed.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::flush_translation_cache category::flush_translation_cache test_category_crud->category::flush_translation_cache db_foreach db_foreach (public) category::flush_translation_cache->db_foreach category::delete category::delete (public) category::delete->category::flush_translation_cache category::update category::update (public) category::update->category::flush_translation_cache

Testcases:
category_crud

category::get (public)

 category::get -category_id category_id [ -locale locale ]

Get name and description for a category_id in the given or connection's locale. If for the combination of category and locale no entry in category_translations exists, then empty is returned.

Switches:
-category_id
(required)
-locale
(optional)
Options:
-category_id
category_id of the category to be queried.
-locale
locale of the language. [ad_conn locale] used by default.
Returns:
list of attribute value pairs containing name and description

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::get category::get test_category_crud->category::get test_category_get_procs category_get_procs (test categories) test_category_get_procs->category::get ad_conn ad_conn (public) category::get->ad_conn db_0or1row db_0or1row (public) category::get->db_0or1row packages/categories/www/cadmin/category-form.tcl packages/categories/ www/cadmin/category-form.tcl packages/categories/www/cadmin/category-form.tcl->category::get

Testcases:
category_crud, category_get_procs

category::get_children (public)

 category::get_children -category_id category_id

Returns the category ids of the direct children of the given category

Switches:
-category_id
(required)
category_id
Returns:
list of category ids of the children of the supplied category_id
Author:
Peter Kreuzinger <peter.kreuzinger@wu-wien.ac.at>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::get_children category::get_children test_category_crud->category::get_children test_category_get_procs category_get_procs (test categories) test_category_get_procs->category::get_children test_category_tree_procs category_tree_procs (test categories) test_category_tree_procs->category::get_children db_list db_list (public) category::get_children->db_list

Testcases:
category_crud, category_get_procs, category_tree_procs

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.

Parameters:
category_id - category_id to get the names.
locale (optional) - language in which to get the names. [ad_conn locale] used by default.
Returns:
list of category_id, category_name, tree_id and tree_name.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_data category::get_data test_category_get_procs->category::get_data category::get_name category::get_name (public) category::get_data->category::get_name category::get_tree category::get_tree (public) category::get_data->category::get_tree category_tree::get_name category_tree::get_name (public) category::get_data->category_tree::get_name Class ::xowiki::includelet::my-categories Class ::xowiki::includelet::my-categories (public) Class ::xowiki::includelet::my-categories->category::get_data category::list::get_pretty_list category::list::get_pretty_list (public) category::list::get_pretty_list->category::get_data

Testcases:
category_get_procs

category::get_id (public)

 category::get_id name [ locale ]

Gets the id of a category given a name.

Parameters:
name - the name of the category to retrieve
locale (defaults to "en_US") - the locale in which the name is supplied
Returns:
the category id or empty string if no category was found
Author:
Lee Denison <lee@xarg.co.uk>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_id category::get_id test_category_get_procs->category::get_id db_string db_string (public) category::get_id->db_string

Testcases:
category_get_procs

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

Parameters:
title - object title of the category to retrieve
Returns:
the category id or empty string if no category was found
Author:
Peter Kreuzinger <peter.kreuzinger@wu-wien.ac.at>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_id_by_object_title category::get_id_by_object_title test_category_get_procs->category::get_id_by_object_title db_string db_string (public) category::get_id_by_object_title->db_string

Testcases:
category_get_procs

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.

Switches:
-tree_id
(optional)
Parameters:
object_id - object of which we want to know the mapped categories.
Returns:
tcl-list of category_ids
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_object_mapping category_object_mapping (test categories) category::get_mapped_categories category::get_mapped_categories test_category_object_mapping->category::get_mapped_categories db_list db_list (public) category::get_mapped_categories->db_list Class ::xowiki::includelet::my-categories Class ::xowiki::includelet::my-categories (public) Class ::xowiki::includelet::my-categories->category::get_mapped_categories category::ad_form::fill_widgets category::ad_form::fill_widgets (public) category::ad_form::fill_widgets->category::get_mapped_categories fs::category_links fs::category_links (private) fs::category_links->category::get_mapped_categories packages/categories/lib/categorize.tcl packages/categories/ lib/categorize.tcl packages/categories/lib/categorize.tcl->category::get_mapped_categories packages/categories/www/include/widget.tcl packages/categories/ www/include/widget.tcl packages/categories/www/include/widget.tcl->category::get_mapped_categories

Testcases:
category_object_mapping

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

Switches:
-locale
(optional)
-multirow
(defaults to "mapped_categories") (optional)
Parameters:
object_id - object of which we want to know the mapped categories.
Returns:
multirow with tree and category information
Author:
Peter Kreuzinger <peter.kreuzinger@wu-wien.ac.at>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_object_mapping category_object_mapping (test categories) category::get_mapped_categories_multirow category::get_mapped_categories_multirow test_category_object_mapping->category::get_mapped_categories_multirow ad_conn ad_conn (public) category::get_mapped_categories_multirow->ad_conn db_multirow db_multirow (public) category::get_mapped_categories_multirow->db_multirow

Testcases:
category_object_mapping

category::get_name (public)

 category::get_name category_id [ locale ]

Gets the category name in the specified language, if available. Use default language otherwise.

Parameters:
category_id - category_id or list of category_id's for which to get the name.
locale (optional) - language in which to get the name. [ad_conn locale] used by default.
Returns:
list of names corresponding to the supplied category_id.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::get_name category::get_name test_category_crud->category::get_name test_category_get_procs category_get_procs (test categories) test_category_get_procs->category::get_name test_category_tree_procs category_tree_procs (test categories) test_category_tree_procs->category::get_name ad_conn ad_conn (public) category::get_name->ad_conn lang::system::locale lang::system::locale (public) category::get_name->lang::system::locale lang::util::default_locale_from_lang lang::util::default_locale_from_lang (public) category::get_name->lang::util::default_locale_from_lang parameter::get parameter::get (public) category::get_name->parameter::get Class ::xowiki::includelet::categories-recent Class ::xowiki::includelet::categories-recent (public) Class ::xowiki::includelet::categories-recent->category::get_name category::get_data category::get_data (public) category::get_data->category::get_name category::get_names category::get_names (public) category::get_names->category::get_name category::list::prepare_display category::list::prepare_display (public) category::list::prepare_display->category::get_name category_tree::get_tree category_tree::get_tree (public) category_tree::get_tree->category::get_name

Testcases:
category_crud, category_get_procs, category_tree_procs

category::get_names (public)

 category::get_names category_ids [ locale ]

Gets the category name in the specified language, if available. Use default language otherwise.

Parameters:
category_ids - category_ids for which to get the name.
locale (optional) - language in which to get the name. [ad_conn locale] used by default.
Returns:
list of names corresponding to the list of category_id's supplied.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_names category::get_names test_category_get_procs->category::get_names test_category_tree_procs category_tree_procs (test categories) test_category_tree_procs->category::get_names category::get_name category::get_name (public) category::get_names->category::get_name packages/faq/www/categories/list-categories.tcl packages/faq/ www/categories/list-categories.tcl packages/faq/www/categories/list-categories.tcl->category::get_names

Testcases:
category_get_procs, category_tree_procs

category::get_object_context (public)

 category::get_object_context object_id

Returns the object name and url to be used in a context bar.

Parameters:
object_id - object_id to get the name of.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_object_mapping category_object_mapping (test categories) category::get_object_context category::get_object_context test_category_object_mapping->category::get_object_context acs_object_name acs_object_name (public) category::get_object_context->acs_object_name category::context_bar category::context_bar (private) category::context_bar->category::get_object_context packages/categories/www/cadmin/object-map.tcl packages/categories/ www/cadmin/object-map.tcl packages/categories/www/cadmin/object-map.tcl->category::get_object_context packages/categories/www/cadmin/tree-form.tcl packages/categories/ www/cadmin/tree-form.tcl packages/categories/www/cadmin/tree-form.tcl->category::get_object_context packages/categories/www/cadmin/tree-map-2.tcl packages/categories/ www/cadmin/tree-map-2.tcl packages/categories/www/cadmin/tree-map-2.tcl->category::get_object_context packages/categories/www/cadmin/tree-map.tcl packages/categories/ www/cadmin/tree-map.tcl packages/categories/www/cadmin/tree-map.tcl->category::get_object_context

Testcases:
category_object_mapping

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

Switches:
-category_id
(required)
CategoryID of the category we want to get the objects for
-object_type
(optional)
Limit the search for objects of this object type
-content_type
(optional)
Limit the search for objects of this content_type
-include_children
(boolean) (optional)
Include child categories' objects as well. Not yet implemented
Author:
malte ()
Created:
Wed May 30 06:28:25 CEST 2007

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_object_mapping category_object_mapping (test categories) category::get_objects category::get_objects test_category_object_mapping->category::get_objects db_list db_list (public) category::get_objects->db_list

Testcases:
category_object_mapping

category::get_parent (public)

 category::get_parent -category_id category_id

Returns the category id of the parent category

Switches:
-category_id
(required)
category_id
Returns:
category id of the parent category
Author:
Peter Kreuzinger <peter.kreuzinger@wu-wien.ac.at>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_parent category::get_parent test_category_get_procs->category::get_parent db_string db_string (public) category::get_parent->db_string

Testcases:
category_get_procs

category::get_tree (public)

 category::get_tree category_id

Gets the tree_id of the given category.

Parameters:
category_id - category_id or list of category_id's for which to get the tree_id.
Returns:
tree_id of the tree the category belongs to.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_get_procs category_get_procs (test categories) category::get_tree category::get_tree test_category_get_procs->category::get_tree category::get_data category::get_data (public) category::get_data->category::get_tree category::list::prepare_display category::list::prepare_display (public) category::list::prepare_display->category::get_tree install::xml::action::map-category-tree install::xml::action::map-category-tree (public) install::xml::action::map-category-tree->category::get_tree xowiki::notification::do_notifications xowiki::notification::do_notifications (public) xowiki::notification::do_notifications->category::get_tree

Testcases:
category_get_procs

category::indent_html (public, deprecated)

 category::indent_html indent_width
Deprecated. Invoking this procedure generates a warning.

Creates a series of   to indent subcatories in html output.

Parameters:
indent_width - width of the html indent.
Author:
Timo Hentschel <timo@timohentschel.de>
See Also:
  • string repeat " " $i

Partial Call Graph (max 5 caller/called nodes):
%3 ad_log_deprecated ad_log_deprecated (public) category::indent_html category::indent_html category::indent_html->ad_log_deprecated

Testcases:
No testcase defined.

category::map_object (public)

 category::map_object [ -remove_old ] -object_id object_id \
    category_id_list

Map an object to several categories.

Switches:
-remove_old
(boolean) (optional)
-object_id
(required)
Parameters:
category_id_list - tcl-list of category_ids to be mapped to the object.
Options:
-remove_old
Modifier to be used when categorizing existing objects. Will make sure to delete all old categorizations.
-object_id
object to be categorized.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_object_mapping category_object_mapping (test categories) category::map_object category::map_object test_category_object_mapping->category::map_object category::delete category::delete (public) category::map_object->category::delete db_dml db_dml (public) category::map_object->db_dml db_transaction db_transaction (public) category::map_object->db_transaction Class ::Generic::Form Class ::Generic::Form (public) Class ::Generic::Form->category::map_object Generic::Form instproc generate Generic::Form instproc generate (public) Generic::Form instproc generate->category::map_object packages/categories/lib/map.tcl packages/categories/ lib/map.tcl packages/categories/lib/map.tcl->category::map_object packages/faq/www/admin/q-and-a-add-edit.tcl packages/faq/ www/admin/q-and-a-add-edit.tcl packages/faq/www/admin/q-and-a-add-edit.tcl->category::map_object packages/file-storage/www/file-add.tcl packages/file-storage/ www/file-add.tcl packages/file-storage/www/file-add.tcl->category::map_object

Testcases:
category_object_mapping

category::pageurl (private)

 category::pageurl object_id

Returns the page that displays a category. To be used by the AcsObject.PageUrl service contract.

Parameters:
object_id - category to be displayed.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_AcsObject_service_contract_implementations AcsObject_service_contract_implementations (test categories) category::pageurl category::pageurl test_AcsObject_service_contract_implementations->category::pageurl db_string db_string (public) category::pageurl->db_string AcsSc.acsobject.pageurl.category_idhandler AcsSc.acsobject.pageurl.category_idhandler (private) AcsSc.acsobject.pageurl.category_idhandler->category::pageurl

Testcases:
AcsObject_service_contract_implementations

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.

Parameters:
category_id - category_id of the category to be phased in
Author:
Timo Hentschel <timo@timohentschel.de>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::phase_in category::phase_in test_category_crud->category::phase_in db_exec_plsql db_exec_plsql (public) category::phase_in->db_exec_plsql packages/categories/www/cadmin/category-phase-in.tcl packages/categories/ www/cadmin/category-phase-in.tcl packages/categories/www/cadmin/category-phase-in.tcl->category::phase_in

Testcases:
category_crud

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.

Parameters:
category_id - category_id of the category to be phased out
Author:
Timo Hentschel <timo@timohentschel.de>
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::phase_out category::phase_out test_category_crud->category::phase_out db_exec_plsql db_exec_plsql (public) category::phase_out->db_exec_plsql packages/categories/www/cadmin/category-phase-out.tcl packages/categories/ www/cadmin/category-phase-out.tcl packages/categories/www/cadmin/category-phase-out.tcl->category::phase_out

Testcases:
category_crud

category::reset_translation_cache (public)

 category::reset_translation_cache

Reloads all category translations in the cache.

Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_init_procs category_init_procs (test categories) category::reset_translation_cache category::reset_translation_cache test_category_init_procs->category::reset_translation_cache db_foreach db_foreach (public) category::reset_translation_cache->db_foreach category_tree::copy category_tree::copy (public) category_tree::copy->category::reset_translation_cache category_tree::delete category_tree::delete (public) category_tree::delete->category::reset_translation_cache packages/categories/tcl/categories-init.tcl packages/categories/ tcl/categories-init.tcl packages/categories/tcl/categories-init.tcl->category::reset_translation_cache

Testcases:
category_init_procs

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.

Switches:
-category_id
(required)
-name
(required)
-locale
(optional)
-description
(optional)
-user_id
(optional)
-modifying_ip
(optional)
Options:
-category_id
category_id of the category to be updated.
-locale
locale of the language. [ad_conn locale] used by default.
-name
category name.
-description
description of the category.
-user_id
user that updates the category. [ad_conn user_id] used by default.
-modifying_ip
ip-address of the user that updates the category. [ad_conn peeraddr] used by default.
Author:
Timo Hentschel <timo@timohentschel.de>

Partial Call Graph (max 5 caller/called nodes):
%3 test_category_crud category_crud (test categories) category::update category::update test_category_crud->category::update ad_conn ad_conn (public) category::update->ad_conn category::flush_translation_cache category::flush_translation_cache (public) category::update->category::flush_translation_cache db_0or1row db_0or1row (public) category::update->db_0or1row db_exec_plsql db_exec_plsql (public) category::update->db_exec_plsql db_transaction db_transaction (public) category::update->db_transaction category_tree::xml::add_category category_tree::xml::add_category (private) category_tree::xml::add_category->category::update packages/categories/www/cadmin/category-form.tcl packages/categories/ www/cadmin/category-form.tcl packages/categories/www/cadmin/category-form.tcl->category::update

Testcases:
category_crud
[ show source ]