/sources/ocf_forumview.php

Description
Functions
ocf_get_forum_view (line 224)

Get a map of details relating to the view of a certain forum of a certain member.

  • return: The details.
array ocf_get_forum_view ([integer $start = 0], [?integer $max = NULL], [?MEMBER $forum_id = NULL])
  • integer $start: The start row for getting details of topics in the forum (i.e. 0 is newest, higher is starting further back in time).
  • ?integer $max: The maximum number of topics to get detail of (NULL: default).
  • ?MEMBER $forum_id: The member viewing (NULL: current member).
ocf_get_topic_array (line 30)

Get details of a topic (to show eventually as a row in a forum or results view). This is a helper function, and thus the interface is not very user friendly.

  • return: The details.
array ocf_get_topic_array (array $topic_row, MEMBER $member_id, integer $hot_topic_definition, boolean $involved)
  • array $topic_row: The DB row of the topic.
  • MEMBER $member_id: The member the details are being prepared for.
  • integer $hot_topic_definition: The hot topic definition (taken from the config options).
  • boolean $involved: Whether the viewing member has a post in the topic.
ocf_render_topic (line 110)

Render a topic row (i.e. a row in a forum or results view), from given details (from ocf_get_topic_array).

  • return: The topic row.
tempcode ocf_render_topic (array $topic, boolean $may_mass_moderate, [boolean $pt = false], [?string $show_forum = NULL])
  • array $topic: The details (array containing: last_post_id, id, modifiers, emoticon, first_member_id, first_username, first_post, num_posts, num_views).
  • boolean $may_mass_moderate: Whether the viewing member is allowed to mass moderate.
  • boolean $pt: Whether the topic is a personal topic.
  • ?string $show_forum: The forum name (NULL: do not show the forum name).

Documentation generated on Sun, 02 Jan 2011 23:19:41 +0000 by phpDocumentor 1.4.3