Class Module_topics

Description

Module page class.

Located in /forum/pages/modules/topics.php (line 24)


	
			
Method Summary
tempcode add_poll ([?AUTO_LINK $topic_id = NULL])
tempcode attach_quotes (array $quotes)
tempcode birthday ()
tempcode cascade_topic ()
tempcode cascade_topics ()
tempcode categorise_pts ()
void check_has_mod_access (AUTO_LINK $topic_id)
tempcode choose_topic_emoticon ([ID_TEXT $selected_path = ''])
tempcode close_topic ()
tempcode close_topics ()
tempcode delete_poll ()
tempcode delete_post ()
tempcode delete_posts ()
tempcode delete_topic ()
tempcode delete_topics ()
tempcode edit_poll ()
tempcode edit_post ()
tempcode edit_topic ()
?array get_entry_points ()
array get_markers ()
tempcode get_poll_form_fields ([SHORT_TEXT $question = ''], [?array $answers = NULL], [BINARY $is_private = 0], [BINARY $is_open = 1], [BINARY $requires_reply = 0], [BINARY $minimum_selections = 1], [BINARY $maximum_selections = 1])
array get_sp_overrides ()
void handle_topic_breadcrumbs (AUTO_LINK $forum_id, AUTO_LINK $topic_id, string $topic_name, string $doing)
?array info ()
tempcode invite_member ()
tempcode keep_markers ()
tempcode make_personal ()
tempcode mark_read ()
tempcode mark_read_topic ()
tempcode mark_topics_read ()
tempcode mark_topics_unread ()
tempcode mark_unread_topic ()
tempcode mass_multimod ()
tempcode move_posts_a ()
tempcode move_posts_b ()
tempcode move_topic ()
tempcode move_topics ()
tempcode multimod ()
tempcode new_post ()
tempcode new_pt ()
tempcode new_topic ([boolean $personal_topic = false], [?MEMBER $member_id = NULL], [string $img_path = ''])
array ocf_get_post_templates (AUTO_LINK $forum_id)
void ocf_ping_topic_unread (AUTO_LINK $topic_id)
tempcode open_topic ()
tempcode open_topics ()
tempcode pin_topic ()
tempcode pin_topics ()
array post_templates (AUTO_LINK $forum_id)
tempcode redirect_to (ID_TEXT $_title, AUTO_LINK $topic_id, [?mixed $lang = NULL], [?AUTO_LINK $post_id = NULL])
tempcode redirect_to_forum (ID_TEXT $_title, AUTO_LINK $forum_id, [?mixed $lang = NULL])
tempcode relay_with_reason (ID_TEXT $_title)
tempcode report_post ()
tempcode run ()
tempcode sink_topic ()
tempcode sink_topics ()
tempcode topic_history ()
tempcode track_forum ()
tempcode track_topic ()
tempcode uncascade_topic ()
tempcode uncascade_topics ()
tempcode unpin_topic ()
tempcode unpin_topics ()
tempcode unsink_topic ()
tempcode unsink_topics ()
tempcode untrack_forum ()
tempcode untrack_topic ()
tempcode validate_post ()
tempcode validate_posts ()
tempcode vote_poll ()
tempcode whisper ()
tempcode _add_poll ()
tempcode _add_reply ()
tempcode _categorise_pts ()
tempcode _delete_poll ()
tempcode _delete_post ()
tempcode _delete_posts ()
tempcode _delete_topic ()
tempcode _delete_topics ()
tempcode _edit_poll ()
tempcode _edit_post ()
tempcode _edit_topic ()
tempcode _invite_member ()
tempcode _make_personal ()
tempcode _mass_multimod ()
tempcode _move_posts ()
tempcode _move_topic ()
tempcode _move_topics ()
tempcode _multimod ()
string _post_javascript ()
Methods
add_poll (line 2272)

The UI to add a poll.

  • return: The UI
tempcode add_poll ([?AUTO_LINK $topic_id = NULL])
  • ?AUTO_LINK $topic_id: The topic ID to add the poll to (NULL: it is instead gettable from a GET parameter named 'id')
attach_quotes (line 1118)

Create a default post based on a template of quoting the given list of quotes.

  • return: The default post
tempcode attach_quotes (array $quotes)
  • array $quotes: A list of posts to quote
birthday (line 3250)

Redirect to a screen suitable for celebrating a members birthday (existing topic, if possible).

  • return: The UI
tempcode birthday ()
cascade_topic (line 3026)

The actualiser to cascade a topic.

  • return: The UI
tempcode cascade_topic ()
cascade_topics (line 687)

The actualiser to cascade topics.

  • return: The UI
tempcode cascade_topics ()
categorise_pts (line 974)

The UI to categorise some PTs.

  • return: The UI
tempcode categorise_pts ()
check_has_mod_access (line 2605)

Check there is at least some moderation access over the given topic.

void check_has_mod_access (AUTO_LINK $topic_id)
  • AUTO_LINK $topic_id: The topic ID
choose_topic_emoticon (line 1082)

Choose an emoticon for a topic.

  • return: The emoticon input field
tempcode choose_topic_emoticon ([ID_TEXT $selected_path = ''])
  • ID_TEXT $selected_path: The currently selected emoticon
close_topic (line 3068)

The actualiser to close a topic.

  • return: The UI
tempcode close_topic ()
close_topics (line 765)

The actualiser to close topics.

  • return: The UI
tempcode close_topics ()
delete_poll (line 2886)

The UI to grab a reason for deleting a poll.

  • return: The UI
tempcode delete_poll ()
delete_post (line 2072)

The UI to grab a reason for deleting a post.

  • return: The UI
tempcode delete_post ()
delete_posts (line 355)

The UI to delete some posts.

  • return: The UI
tempcode delete_posts ()
delete_topic (line 2711)

The UI to delete a topic.

  • return: The UI
tempcode delete_topic ()
delete_topics (line 938)

The UI to delete some topics.

  • return: The UI
tempcode delete_topics ()
edit_poll (line 2798)

The UI to edit a poll.

  • return: The UI
tempcode edit_poll ()
edit_post (line 2411)

The UI to edit a post.

  • return: The UI
tempcode edit_post ()
edit_topic (line 2626)

The UI to edit a topic.

  • return: The UI
tempcode edit_topic ()
get_entry_points (line 49)

Standard modular entry-point finder function.

  • return: A map of entry points (type-code=>language-code) (NULL: disabled).
?array get_entry_points ()
get_markers (line 248)

Extract marker IDs that were past through in the GET/POST.

  • return: A list of markers
array get_markers ()
get_poll_form_fields (line 2241)

Get tempcode for a poll adding/editing form.

  • return: The tempcode for the fields
tempcode get_poll_form_fields ([SHORT_TEXT $question = ''], [?array $answers = NULL], [BINARY $is_private = 0], [BINARY $is_open = 1], [BINARY $requires_reply = 0], [BINARY $minimum_selections = 1], [BINARY $maximum_selections = 1])
  • SHORT_TEXT $question: The poll question
  • ?array $answers: A list of current answers for the poll (NULL: none yet)
  • BINARY $is_private: Whether it is a private poll (blind poll, where the results aren't visible until made public)
  • BINARY $is_open: Whether the poll is open for voting
  • BINARY $requires_reply: Whether a reply to the poll topic is required before voting
  • BINARY $minimum_selections: The minimum number of selections for voters
  • BINARY $maximum_selections: The maximum number of selections for voters
get_sp_overrides (line 59)

Standard modular specific-permission-overide finder function.

  • return: A map of specific-permissions that are overridable; sp to 0 or 1. 0 means "not category overridable". 1 means "category overridable".
array get_sp_overrides ()
handle_topic_breadcrumbs (line 1432)

Sort out breadcrumbing for a forum/topic/additional combination.

void handle_topic_breadcrumbs (AUTO_LINK $forum_id, AUTO_LINK $topic_id, string $topic_name, string $doing)
  • AUTO_LINK $forum_id: The forum for breadcrumbing
  • AUTO_LINK $topic_id: The topic for breadcrumbing
  • string $topic_name: The topic name
  • string $doing: The action currently being done
info (line 32)

Standard modular info function.

  • return: Map of module info (NULL: module is disabled).
?array info ()
invite_member (line 2760)

The UI to invite a member to a PT.

  • return: The UI
tempcode invite_member ()
keep_markers (line 263)

Copy marker IDs that were past through in the GET/POST into hidden form fields, so they may be relayed.

  • return: Hidden fields facilitating the marker relaying
tempcode keep_markers ()
make_personal (line 3192)

The UI to make a normal topic a personal topic.

  • return: The UI
tempcode make_personal ()
mark_read (line 3176)

The actualiser to mark a forum as read.

  • return: The UI
tempcode mark_read ()
mark_read_topic (line 2026)

The actualiser to mark a topic as read.

  • return: The UI
tempcode mark_read_topic ()
mark_topics_read (line 512)

The actualiser to mark topics as read.

  • return: The UI
tempcode mark_topics_read ()
mark_topics_unread (line 554)

The actualiser to mark topics as unread.

  • return: The UI
tempcode mark_topics_unread ()
mark_unread_topic (line 2052)

The actualiser to mark a topic as unread.

  • return: The UI
tempcode mark_unread_topic ()
mass_multimod (line 791)

The UI to run multi-moderations.

  • return: The UI
tempcode mass_multimod ()
move_posts_a (line 400)

The UI to move some posts.

  • return: The UI
tempcode move_posts_a ()
move_posts_b (line 433)

The UI to move some posts.

  • return: The UI
tempcode move_posts_b ()
move_topic (line 2917)

The UI to move a topic.

  • return: The UI
tempcode move_topic ()
move_topics (line 889)

The UI to move some topics.

  • return: The UI
tempcode move_topics ()
multimod (line 3082)

The UI to run a multi-moderation.

  • return: The UI
tempcode multimod ()
new_post (line 1449)

The UI to make a post.

  • return: The UI
tempcode new_post ()
new_pt (line 1402)

The UI to create a PT.

  • return: The UI
tempcode new_pt ()
new_topic (line 1218)

The UI to create a new topic.

  • return: The UI
tempcode new_topic ([boolean $personal_topic = false], [?MEMBER $member_id = NULL], [string $img_path = ''])
  • boolean $personal_topic: Whether a new personal topic is being created
  • ?MEMBER $member_id: The member ID being whispered too (NULL: N/A)
  • string $img_path: Theme image code
ocf_get_post_templates (line 1159)

Get a list of post templates that apply to a certain forum.

  • return: The list of applicable post templates.
array ocf_get_post_templates (AUTO_LINK $forum_id)
  • AUTO_LINK $forum_id: The ID of the forum.
ocf_ping_topic_unread (line 544)

Mark a topic as unread by the current member.

void ocf_ping_topic_unread (AUTO_LINK $topic_id)
  • AUTO_LINK $topic_id: The ID of the topic to mark as unread.
open_topic (line 3054)

The actualiser to open a topic.

  • return: The UI
tempcode open_topic ()
open_topics (line 739)

The actualiser to open topics.

  • return: The UI
tempcode open_topics ()
pin_topic (line 2970)

The actualiser to pin a topic.

  • return: The UI
tempcode pin_topic ()
pin_topics (line 583)

The actualiser to pin topics.

  • return: The UI
tempcode pin_topics ()
post_templates (line 1183)

The form element for choosing a post template.

  • return: A pair: The form element (tempcode) and the default post to make
array post_templates (AUTO_LINK $forum_id)
  • AUTO_LINK $forum_id: The forum ID we are looking for post templates active in
redirect_to (line 200)

Do a redirection page to a certain topic/post (because we've just done an action and want to go back).

  • return: The UI
tempcode redirect_to (ID_TEXT $_title, AUTO_LINK $topic_id, [?mixed $lang = NULL], [?AUTO_LINK $post_id = NULL])
  • ID_TEXT $_title: The language ID for the title to use in the page
  • AUTO_LINK $topic_id: The ID of the topic to redirect to
  • ?mixed $lang: What to output (Tempcode or string) (NULL: default)
  • ?AUTO_LINK $post_id: The ID of the post to redirect to (NULL: redirect to topic instead)
redirect_to_forum (line 227)

Do a redirection page to a certain forum (because we've just done an action and want to go back).

  • return: The UI
tempcode redirect_to_forum (ID_TEXT $_title, AUTO_LINK $forum_id, [?mixed $lang = NULL])
  • ID_TEXT $_title: The language ID for the title to use in the page
  • AUTO_LINK $forum_id: The ID of the forum to redirect to
  • ?mixed $lang: What to output (Tempcode or string) (NULL: default)
relay_with_reason (line 175)

The UI for a trivial form page that just asks a reason before relaying the results to the same URL, but with an underscored type.

  • return: The UI
tempcode relay_with_reason (ID_TEXT $_title)
  • ID_TEXT $_title: The language ID for the title to use in the page
report_post (line 1638)

The UI to report a post.

  • return: The UI
tempcode report_post ()
run (line 70)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
sink_topic (line 2998)

The actualiser to pin a topic.

  • return: The UI
tempcode sink_topic ()
sink_topics (line 635)

The actualiser to pin topics.

  • return: The UI
tempcode sink_topics ()
topic_history (line 3160)

A redirect for viewing post history: made like this so the history button can fit into the same URL architecture as the other post buttons.

  • return: The UI
tempcode topic_history ()
track_forum (line 283)

The actualiser to track a forum.

  • return: The UI
tempcode track_forum ()
track_topic (line 2000)

The actualiser to track a topic.

  • return: The UI
tempcode track_topic ()
uncascade_topic (line 3040)

The actualiser to uncascade a topic.

  • return: The UI
tempcode uncascade_topic ()
uncascade_topics (line 713)

The actualiser to uncascade topics.

  • return: The UI
tempcode uncascade_topics ()
unpin_topic (line 2984)

The actualiser to unpin a topic.

  • return: The UI
tempcode unpin_topic ()
unpin_topics (line 609)

The actualiser to unpin topics.

  • return: The UI
tempcode unpin_topics ()
unsink_topic (line 3012)

The actualiser to unpin a topic.

  • return: The UI
tempcode unsink_topic ()
unsink_topics (line 661)

The actualiser to unpin topics.

  • return: The UI
tempcode unsink_topics ()
untrack_forum (line 301)

The actualiser to untrack a forum.

  • return: The UI
tempcode untrack_forum ()
untrack_topic (line 2013)

The actualiser to untrack a topic.

  • return: The UI
tempcode untrack_topic ()
validate_post (line 2578)

The actualiser to validate a post.

  • return: The UI
tempcode validate_post ()
validate_posts (line 323)

The actualiser to validate some posts.

  • return: The UI
tempcode validate_posts ()
vote_poll (line 2197)

The actualiser to vote in a poll.

  • return: The UI
tempcode vote_poll ()
whisper (line 1058)

The UI to choose between the two types of whisper.

  • return: The UI
tempcode whisper ()
_add_poll (line 2338)

The actualiser to add a poll.

  • return: The UI
tempcode _add_poll ()
_add_reply (line 1713)

The actualiser to add a reply.

  • return: The UI
tempcode _add_reply ()
_categorise_pts (line 1011)

The actualiser to categorise some PTs.

  • return: The UI
tempcode _categorise_pts ()
_delete_poll (line 2901)

The actualiser to delete a poll.

  • return: The UI
tempcode _delete_poll ()
_delete_post (line 2113)

The actualiser for deleting a post.

  • return: The UI
tempcode _delete_post ()
_delete_posts (line 374)

The actualiser to delete some posts.

  • return: The UI
tempcode _delete_posts ()
_delete_topic (line 2743)

The actualiser to delete a topic.

  • return: The UI
tempcode _delete_topic ()
_delete_topics (line 956)

The actualiser to delete some topics.

  • return: The UI
tempcode _delete_topics ()
_edit_poll (line 2839)

The actualiser to edit a poll.

  • return: The UI
tempcode _edit_poll ()
_edit_post (line 2529)

The actualiser to edit a post.

  • return: The UI
tempcode _edit_post ()
_edit_topic (line 2682)

The actualiser to edit a topic.

  • return: The UI
tempcode _edit_topic ()
_invite_member (line 2779)

The actualiser to invite a member to a PT.

  • return: The UI
tempcode _invite_member ()
_make_personal (line 3221)

The actualiser to make a normal topic a personal topic.

  • return: The UI
tempcode _make_personal ()
_mass_multimod (line 862)

The actualiser to run multi moderations.

  • return: The UI
tempcode _mass_multimod ()
_move_posts (line 470)

The actualiser to move some posts.

  • return: The UI
tempcode _move_posts ()
_move_topic (line 2952)

The actualiser to move a topic.

  • return: The UI
tempcode _move_topic ()
_move_topics (line 919)

The actualiser to move some topics.

  • return: The UI
tempcode _move_topics ()
_multimod (line 3144)

The actualiser to run a multi moderation.

  • return: The UI
tempcode _multimod ()
_post_javascript (line 2500)

Get Javascript to restrict post lengths.

  • return: The post Javascript
string _post_javascript ()

Documentation generated on Sun, 02 Jan 2011 23:27:12 +0000 by phpDocumentor 1.4.3