/sources/menus.php

Description
Description | Functions
Functions
Description | Functions
build_community_menu (line 192)

Build community menu.

  • return: Faked database rows
array build_community_menu ()
build_management_menu (line 103)

Build management menu.

  • return: Faked database rows
array build_management_menu ()
build_stored_menu (line 283)

Take a stored menu identifier, and return an XHTML menu created from it.

  • return: The generated tempcode of the menu
tempcode build_stored_menu (ID_TEXT $type, SHORT_TEXT $menu, [boolean $silent_failure = false])
  • ID_TEXT $type: The type of the menu (determines which templates to use)
  • SHORT_TEXT $menu: The menu identifier to use
  • boolean $silent_failure: Whether to silently return blank if the menu does not exist
build_stored_menu_branch (line 389)

Build a menu branch map from a database row.

  • return: The menu branch map
array build_stored_menu_branch (array $thisitem, array $items)
  • array $thisitem: The database row
  • array $items: List of all the database rows for this menu
build_stored_menu_hooked (line 37)

Build a pseudo 'stored menu' out of do_next_menus hooks (we create database rows so we can render it as a normal stored menu).

  • return: Faked database rows
array build_stored_menu_hooked (array $collect, ID_TEXT $type, [?integer $parent = NULL])
  • array $collect: The complete collection of hooks
  • ID_TEXT $type: The encoded 'type' in the menu tree we are showing for at (textual parent)
  • ?integer $parent: The parent ID (NULL: no parent)
build_zone_menu (line 235)

Build zone menu.

  • return: Faked database rows
array build_zone_menu ()
init__menus (line 24)

Standard code module initialisation function.

void init__menus ()
num_staff_icons (line 861)

Find the number of icons the member of staff has.

  • return: The count
integer num_staff_icons ()
render_menu (line 518)

Render a stored menu to tempcode.

  • return: The generated tempcode of the menu
tempcode render_menu (array $menu, ?MEMBER $source_member, ID_TEXT $type, [boolean $as_admin = false])
  • array $menu: Menu details
  • ?MEMBER $source_member: The member the menu is being built as (NULL: current member)
  • ID_TEXT $type: The menu type (determines what templates get used)
  • boolean $as_admin: Whether to generate Comcode with admin privilege
render_menu_branch (line 569)

Render a menu branch to tempcode.

  • return: A pair: the generated string/tempcode of the menu branch, and whether it is expanded
array render_menu_branch (array $branch, SHORT_TEXT $codename, MEMBER $source_member, integer $level, ID_TEXT $type, boolean $as_admin, integer $num_entries, integer $position, array $all_branches, [integer $the_level = 1])
  • array $branch: The menu branch map
  • SHORT_TEXT $codename: An identifier for the menu (will be used as a unique id by menu javascript code)
  • MEMBER $source_member: The member the menu is being built as
  • integer $level: The depth into the menu that this branch resides at
  • ID_TEXT $type: The menu type (determines what templates get used)
  • boolean $as_admin: Whether to generate Comcode with admin privilege
  • integer $num_entries: The number of entries on this level (doesn't take filtering into account)
  • integer $position: The position in the entries on this level
  • array $all_branches: Array of all other branches
  • integer $the_level: The level

Documentation generated on Sun, 02 Jan 2011 23:17:47 +0000 by phpDocumentor 1.4.3