init__ocf_forums (line 24)
Standard code module initialisation function.
void
init__ocf_forums
()
ocf_forum_breadcrumbs (line 213)
Get a forum navigation tree (a horizontal thing that works backwards along the tree path ['bread crumb trail'], not a full tree).
tempcode
ocf_forum_breadcrumbs
(mixed $end_point_forum, [?string $this_name = NULL], [?AUTO_LINK $parent_forum = NULL], [boolean $start = true])
-
mixed
$end_point_forum: The ID of the forum we are at in our path (NULL: end of recursion) (false: no forum ID available, this_name and parent_forum must not be NULL).
-
?string
$this_name: The name of the given forum (NULL: find it from the DB).
-
?AUTO_LINK
$parent_forum: The parent forum of the given forum (NULL: find it from the DB).
-
boolean
$start: Whether this is being called as the recursion start of deriving the navigation tree (top level call).
ocf_get_all_subordinate_forums (line 71)
Gets a list of subordinate forums of a certain forum.
mixed
ocf_get_all_subordinate_forums
(AUTO_LINK $forum_id, [?string $create_or_list = NULL], [?array $tree = NULL], [boolean $ignore_permissions = false])
-
AUTO_LINK
$forum_id: The ID of the forum we are finding subordinate forums of.
-
?string
$create_or_list: The field name to use in the OR list (NULL: do not make an OR list, return an array).
-
?array
$tree: The forum tree structure (NULL: unknown, it will be found using ocf_organise_into_tree).
-
boolean
$ignore_permissions: Whether to ignore permissions in this.
ocf_get_forum_parent_or_list (line 192)
Get an OR list of a forums parents, suited for selection from the f_topics table.
string
ocf_get_forum_parent_or_list
(AUTO_LINK $forum_id, [?AUTO_LINK $parent_id = -1])
-
AUTO_LINK
$forum_id: The ID of the forum.
-
?AUTO_LINK
$parent_id: The ID of the parent forum (-1: get it from the DB) (NULL: there is no parent, as it is the root forum).
ocf_is_tracking_forum (line 144)
Find whether a member is tracking a certain forum.
boolean
ocf_is_tracking_forum
(AUTO_LINK $forum_id, [?MEMBER $member_id = NULL])
-
AUTO_LINK
$forum_id: The ID of the forum.
-
?MEMBER
$member_id: The member ID (NULL: current member).
ocf_may_moderate_forum (line 176)
Find whether a member may moderate a certain forum.
boolean
ocf_may_moderate_forum
(AUTO_LINK $forum_id, [?MEMBER $member_id = NULL])
-
AUTO_LINK
$forum_id: The ID of the forum.
-
?MEMBER
$member_id: The member ID (NULL: current member).
ocf_may_track_forum (line 158)
Find whether a member may track a certain forum.
boolean
ocf_may_track_forum
(AUTO_LINK $forum_id, [?MEMBER $member_id = NULL])
-
AUTO_LINK
$forum_id: The ID of the forum.
-
?MEMBER
$member_id: The member ID (NULL: current member).
ocf_organise_into_tree (line 46)
Organise a list of forum rows into a tree structure.
array
ocf_organise_into_tree
(array &$all_forums, AUTO_LINK $forum_id)
-
array
&$all_forums: The list of all forum rows.
-
AUTO_LINK
$forum_id: The forum row that we are taking as the root of our current recursion.