Class Module_admin_menus

Description

Module page class.

Located in /adminzone/pages/modules/admin_menus.php (line 24)


	
			
Method Summary
void add_menu_item (ID_TEXT $menu, integer $id, array &$ids, ?integer $parent, array &$old_menu_bits, integer &$order)
tempcode edit_menu ()
?array get_entry_points ()
tempcode get_menu_name ()
?array info ()
void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
tempcode menu_branch (AUTO_LINK $id, integer $branch, integer &$order, boolean $clickable_sections, array $menu_items)
tempcode run ()
void uninstall ()
tempcode _edit_menu ()
Methods
add_menu_item (line 426)

Add a menu item from details in POST.

void add_menu_item (ID_TEXT $menu, integer $id, array &$ids, ?integer $parent, array &$old_menu_bits, integer &$order)
  • ID_TEXT $menu: The name of the menu the item is on
  • integer $id: The ID of the menu item (i.e. what it is referenced as in POST)
  • array &$ids: The map of IDs on the menu (ID=>parent)
  • ?integer $parent: The ID of the parent branch (NULL: no parent)
  • array &$old_menu_bits: The map of menu id=>string language IDs employed by items before the edit
  • integer &$order: The order this branch has in the editor (and due to linearly moving through, the number of branches shown assembled ready)
edit_menu (line 201)

The UI to edit a menu.

  • return: The UI
tempcode edit_menu ()
get_entry_points (line 136)

Standard modular entry-point finder function.

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

The UI to choose a menu to edit / create a new menu.

  • return: The UI
tempcode get_menu_name ()
info (line 32)

Standard modular info function.

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

Standard modular install function.

void install ([?integer $upgrade_from = NULL], [?integer $upgrade_from_hack = NULL])
  • ?integer $upgrade_from: What version we're upgrading from (NULL: new install)
  • ?integer $upgrade_from_hack: What hack version we're upgrading from (NULL: new-install/not-upgrading-from-a-hacked-version)
menu_branch (line 289)

Show a branch-editor of the menu editor.

  • return: The part of the UI
tempcode menu_branch (AUTO_LINK $id, integer $branch, integer &$order, boolean $clickable_sections, array $menu_items)
  • AUTO_LINK $id: The ID of the branch we are displaying items for
  • integer $branch: The parent branch holding the branch
  • integer &$order: The order this branch has in the editor (and due to linearly moving through, the number of branches shown assembled ready)
  • boolean $clickable_sections: Whether childed branches themselves can have URLs (etc)
  • array $menu_items: All rows on the menu
run (line 146)

Standard modular run function.

  • return: The result of execution.
tempcode run ()
uninstall (line 47)

Standard modular uninstall function.

void uninstall ()
_edit_menu (line 331)

The actualiser to edit a menu.

  • return: The UI
tempcode _edit_menu ()

Documentation generated on Sun, 02 Jan 2011 23:07:22 +0000 by phpDocumentor 1.4.3