ocf_delete_category (line 55)
Delete a forum category.
void
ocf_delete_category
(AUTO_LINK $category_id, AUTO_LINK $target_category_id)
-
AUTO_LINK
$category_id: The ID of the forum category we are editing.
-
AUTO_LINK
$target_category_id: The ID of the category that we will move all the contained forum to.
ocf_delete_forum (line 148)
Delete a forum.
void
ocf_delete_forum
(AUTO_LINK $forum_id, AUTO_LINK $target_forum_id, [BINARY $delete_topics = 0])
-
AUTO_LINK
$forum_id: The ID of the forum we are deleting.
-
AUTO_LINK
$target_forum_id: The ID of the forum that topics will be moved to.
-
BINARY
$delete_topics: Whether to delete topics instead of moving them to the target forum.
ocf_edit_category (line 29)
Edit a forum category.
void
ocf_edit_category
(AUTO_LINK $category_id, SHORT_TEXT $title, SHORT_TEXT $description, BINARY $expanded_by_default)
-
AUTO_LINK
$category_id: The ID of the forum category we are editing.
-
SHORT_TEXT
$title: The title of the forum category.
-
SHORT_TEXT
$description: The description of the forum category.
-
BINARY
$expanded_by_default: Whether the forum category will be shown expanded by default (as opposed to contracted, where contained forums will not be shown until expansion).
ocf_edit_forum (line 81)
Edit a forum.
void
ocf_edit_forum
(AUTO_LINK $forum_id, SHORT_TEXT $name, SHORT_TEXT $description, AUTO_LINK $category_id, ?AUTO_LINK $new_parent, integer $position, BINARY $post_count_increment, BINARY $order_sub_alpha, LONG_TEXT $intro_question, SHORT_TEXT $intro_answer, [SHORT_TEXT $redirection = ''], [ID_TEXT $order = 'last_post'], [boolean $reset_intro_acceptance = false])
-
AUTO_LINK
$forum_id: The ID of the forum we are editing.
-
SHORT_TEXT
$name: The name of the forum.
-
SHORT_TEXT
$description: The description for the forum.
-
AUTO_LINK
$category_id: What forum category the forum will be filed with.
-
?AUTO_LINK
$new_parent: The ID of the parent forum (NULL: this is the root forum).
-
integer
$position: The position of this forum relative to other forums viewable on the same screen (if parent forum hasn't specified automatic ordering).
-
BINARY
$post_count_increment: Whether post counts will be incremented if members post in the forum.
-
BINARY
$order_sub_alpha: Whether the ordering of subforums is done automatically, alphabetically).
-
LONG_TEXT
$intro_question: The question that is shown for newbies to the forum (blank: none).
-
SHORT_TEXT
$intro_answer: The answer to the question (blank: no specific answer.. if there's a 'question', it just requires a click-through).
-
SHORT_TEXT
$redirection: Either blank for no redirection, the ID of another forum we are mirroring, or a URL to redirect to.
-
ID_TEXT
$order: The order the topics are shown in, by default.
-
boolean
$reset_intro_acceptance: Whether to force forum rules to be re-agreed to, if they've just been changed.
ocf_ensure_category_exists (line 236)
Bomb out if the specified forum category doesn't exist.
void
ocf_ensure_category_exists
(AUTO_LINK $category_id)
-
AUTO_LINK
$category_id: The ID of the category.
ocf_ensure_forum_exists (line 251)
Bomb out if the specified forum doesn't exist.
SHORT_TEXT
ocf_ensure_forum_exists
(AUTO_LINK $forum_id)
-
AUTO_LINK
$forum_id: The ID of the forum.
ocf_ping_forum_read_all (line 188)
Mark all recent topics in a certain forum as read for the current member.
void
ocf_ping_forum_read_all
(AUTO_LINK $forum_id)
-
AUTO_LINK
$forum_id: The ID of the forum.
ocf_ping_forum_unread_all (line 217)
Mark all recent topics in a certain forum as unread for the current member.
void
ocf_ping_forum_unread_all
(AUTO_LINK $forum_id)
-
AUTO_LINK
$forum_id: The ID of the forum.
ocf_track_forum (line 269)
Change tracking setting with respect to a certain member and forum.
void
ocf_track_forum
(AUTO_LINK $forum_id, [?MEMBER $member_id = NULL], [boolean $untrack = false], [boolean $check_permissions = true])
-
AUTO_LINK
$forum_id: The ID of the forum.
-
?MEMBER
$member_id: The member (NULL: current member).
-
boolean
$untrack: Whether the member is wanting to be untracking the forum (i.e. if false, they are wanting to be tracking the forum).
-
boolean
$check_permissions: Whether to check permissions to see if the member is allowed to do this.
ocf_wipe_forum_trackings (line 287)
Untrack all forums for a member.
void
ocf_wipe_forum_trackings
([?MEMBER $member_id = NULL])
-
?MEMBER
$member_id: The member ID (NULL: current member).