• Publicity: Public Only All

forums-procs.tcl

Forums Library

Location:
packages/forums/tcl/forums-procs.tcl
Created:
2002-05-17
Author:
Ben Adida
CVS Identification:
$Id: forums-procs.tcl,v 1.38.2.9 2024/08/06 10:16:11 gustafn Exp $

Procedures in this file

Detailed information

forum::attachments_enabled_p (public)

 forum::attachments_enabled_p [ -forum_id forum_id ]

Check if attachments are enabled in forums. If 'forum_id' is not passed, check only if the attachments package is mounted as a child of the current forums package instance. Otherwise, check also if a particular forum's 'attachments_allowed_p' option is true. In case the package is mounted and the option enabled, return 1.

Switches:
-forum_id (optional)
Returns:
1 if the attachments are enabled in the forums, 0 otherwise.

Testcases:
forum_message_new

forum::delete (public)

 forum::delete [ -forum_id forum_id ]

delete a forum

Switches:
-forum_id (optional)

Testcases:
web_forum_new, web_forum_view, web_forum_edit, web_forums_message_and_reply

forum::disable (public)

 forum::disable -forum_id forum_id

Disable a forum

Switches:
-forum_id (required)

Testcases:
forum_enable_disable

forum::edit (public)

 forum::edit -forum_id forum_id [ -name name ] [ -charter charter ] \
    [ -presentation_type presentation_type ] \
    [ -posting_policy posting_policy ] \
    [ -new_questions_allowed_p new_questions_allowed_p ] \
    [ -anonymous_allowed_p anonymous_allowed_p ] \
    [ -attachments_allowed_p attachments_allowed_p ] [ -no_callback ]

Edit a forum

Switches:
-forum_id (required)
-name (optional)
-charter (optional)
-presentation_type (optional)
-posting_policy (optional)
-new_questions_allowed_p (optional)
-anonymous_allowed_p (optional)
-attachments_allowed_p (optional)
-no_callback (optional, boolean)

Testcases:
web_forum_edit, web_forums_message_and_reply

forum::enable (public)

 forum::enable -forum_id forum_id

Enable a forum

Switches:
-forum_id (required)

Testcases:
forum_enable_disable

forum::flush_cache (public)

 forum::flush_cache -forum_id forum_id

Flushes all the forum caches.

Switches:
-forum_id (required)

Testcases:
forum_count_test

forum::flush_namespaced_cache (public)

 forum::flush_namespaced_cache -forum_id forum_id

Unsets namespaced thread variable holding the forum cache

Switches:
-forum_id (required)

Testcases:
forum_count_test

forum::flush_templating_cache (public)

 forum::flush_templating_cache -forum_id forum_id

Flushes forum templating cache, created by template::paginator

Switches:
-forum_id (required)

Testcases:
forum_new

forum::get (public)

 forum::get -forum_id forum_id -array array

get the fields for a forum

Switches:
-forum_id (required)
-array (required)
Returns:

Testcases:
forum_count_test, web_forum_view, web_forum_edit, web_forums_message_and_reply

forum::list_forums (public)

 forum::list_forums -package_id package_id

List all forums in a package

Switches:
-package_id (required)

Testcases:
forum_new

forum::new (public)

 forum::new [ -forum_id forum_id ] -name name [ -charter charter ] \
    [ -presentation_type presentation_type ] \
    [ -posting_policy posting_policy ] -package_id package_id \
    [ -new_questions_allowed_p new_questions_allowed_p ] \
    [ -anonymous_allowed_p anonymous_allowed_p ] \
    [ -attachments_allowed_p attachments_allowed_p ] [ -no_callback ]

create a new forum

Switches:
-forum_id (optional)
-name (required)
-charter (optional)
-presentation_type (optional, defaults to "flat")
-posting_policy (optional, defaults to "open")
-package_id (required)
-new_questions_allowed_p (optional, defaults to "t")
-anonymous_allowed_p (optional, defaults to "f")
-attachments_allowed_p (optional, defaults to "t")
-no_callback (optional, boolean)

Testcases:
forum_new, forum_message_new, forum_count_test, web_forum_new, web_forum_view, web_forum_edit, web_forums_message_and_reply, forum_enable_disable

forum::new_questions_allow (public, deprecated)

 forum::new_questions_allow -forum_id forum_id [ -party_id party_id ]
Deprecated. Invoking this procedure generates a warning.

Allow the users to create new threads in the forum DEPRECATED: either use forum::edit or inline this trivial query.

Switches:
-forum_id (required)
-party_id (optional)
See Also:

Testcases:
No testcase defined.

forum::new_questions_allowed_p (public, deprecated)

 forum::new_questions_allowed_p -forum_id forum_id \
    [ -party_id party_id ]
Deprecated. Invoking this procedure generates a warning.

Check if the users can create new threads in the forum DEPRECATED: the forum::get api already retrieves this information and there is normally no need to invoke this API specifically.

Switches:
-forum_id (required)
-party_id (optional)
See Also:

Testcases:
No testcase defined.

forum::new_questions_deny (public, deprecated)

 forum::new_questions_deny -forum_id forum_id [ -party_id party_id ]
Deprecated. Invoking this procedure generates a warning.

Deny the users to create new threads in the forum DEPRECATED: either use forum::edit or inline this trivial query.

Switches:
-forum_id (required)
-party_id (optional)
See Also:

Testcases:
No testcase defined.

forum::posting_policy_set (public, deprecated)

 forum::posting_policy_set -posting_policy posting_policy \
    -forum_id forum_id
Deprecated. Invoking this procedure generates a warning.

Set the posting policy. This used to happen by setting permissions on the registered_users group, but was reformed to be just a flag on the forum itself in order to support subsite installation. Please use forum::edit instead.

Switches:
-posting_policy (required)
-forum_id (required)
See Also:

Testcases:
No testcase defined.

forum::use_ReadingInfo_p (public)

 forum::use_ReadingInfo_p [ -package_id package_id ]
Switches:
-package_id (optional)
Returns:
1 if the UseReadingInfo package parameter is true, 0 otherwise.

Testcases:
web_forums_message_and_reply

forum::valid_forum_id_p (public)

 forum::valid_forum_id_p -forum_id forum_id [ -package_id package_id ]

checks forum_id

Switches:
-forum_id (required)
-package_id (optional)

Testcases:
forum_new, web_forums_message_and_reply
[ show source ]