/sources/ocf_general.php

Description
Functions
get_group_colour (line 162)

Get a usergroup colour based on it's ID number.

  • return: Colour.
string get_group_colour (GROUP $gid)
  • GROUP $gid: ID number.
ocf_find_birthdays (line 381)

Find all the birthdays in a certain day.

  • return: List of maps describing the members whose birthday it is on the certain day.
array ocf_find_birthdays ([?TIME $time = NULL])
  • ?TIME $time: A timestamps that exists in the certain day (NULL: now).
ocf_get_forums_stats (line 26)

Get some forum stats.

  • return: A map of forum stats.
array ocf_get_forums_stats ()
ocf_read_in_member_profile (line 66)

Get details on a member profile.

  • return: A map of details.
array ocf_read_in_member_profile (MEMBER $member_id, [boolean $lite = true])
  • MEMBER $member_id: The member to get details of.
  • boolean $lite: Whether to get a 'lite' version (contains less detail, therefore less costly).
ocf_screen_button_wrap (line 409)

Turn a list of maps describing buttons, into a tempcode button panel.

  • return: The button panel.
tempcode ocf_screen_button_wrap (array $buttons)
  • array $buttons: List of maps (each map contains: url, img, title).
ocf_wrapper (line 178)

Do the wrapper that fits around OCF module output.

  • return: The wrapped output.
tempcode ocf_wrapper (tempcode $title, tempcode $content, [boolean $show_personal_bar = true], [boolean $show_stats = true], [?AUTO_LINK $forum_id = NULL])
  • tempcode $title: The title for the module output that we are wrapping.
  • tempcode $content: The module output that we are wrapping.
  • boolean $show_personal_bar: Whether to include the personal bar in the wrap.
  • boolean $show_stats: Whether to include statistics in the wrap.
  • ?AUTO_LINK $forum_id: The forum to make the search link search under (NULL: Users own PT forum/unknown).

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