Class Module_vforums

Description

Module page class.

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


	
			
Method Summary
?array get_entry_points ()
?array info ()
array new_posts ()
array recently_read ()
tempcode run ()
array unread_topics ()
tempcode _vforum (SHORT_TEXT $title, mixed $condition, string $order, [boolean $no_pin = false])
Methods
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 ()
info (line 32)

Standard modular info function.

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

The UI to show topics with new posts since last visit time.

  • return: A pair: The Title, The UI
array new_posts ()
recently_read (line 112)

The UI to show topics which have been recently read by the current member.

  • return: A pair: The Title, The UI
array recently_read ()
run (line 59)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
unread_topics (line 99)

The UI to show topics with unread posts.

  • return: A pair: The Title, The UI
array unread_topics ()
_vforum (line 129)

The UI to show a virtual forum.

  • return: The UI
tempcode _vforum (SHORT_TEXT $title, mixed $condition, string $order, [boolean $no_pin = false])
  • SHORT_TEXT $title: The title to show for the v-forum
  • mixed $condition: The condition (a fragment of an SQL query that gets embedded in the context of a topic selection query). May be string, or array of strings (separate queries to run and merge; done for performance reasons relating to DB indexing)
  • string $order: The ordering of the results
  • boolean $no_pin: Whether to not show pinning in a separate section

Documentation generated on Sun, 02 Jan 2011 23:28:33 +0000 by phpDocumentor 1.4.3