com.lokorin.lokorin.lib
[ class tree: com.lokorin.lokorin.lib ] [ index: com.lokorin.lokorin.lib ] [ all elements ]

Procedural File: lib_menu.php

Source Location: /_includes/lib_menu.php



Classes:

MenuItem
Describes an item in a menu. An menu item has a name and are ordered in a tree where all nodes except the root are menu items. An menu item may have any number of children.
ProjectMenu
Describes a project menu. A menu that is connected to a project.


Page Details:

A library that contains everything that is connected to the site's menu.



Tags:

filesource:  Source Code for this file
license:  GNU Lesser General Public License
version:  $Revision: 1.16 $
author:  Andreas Launila


Includes:

require_once('common.php') [line 18]
For access to common constants and functions.






MENU_CACHE_PATH [line 26]

MENU_CACHE_PATH = FOLDER_CACHE.'menu.php'
The path relative to the site's root where the menu cache is located.



Tags:

access:  private

[ Top ]




getAllMenuNames [line 93]

array getAllMenuNames( )

Gets the names of all menu items available.



Tags:

return:  An array full of menu item names (as strings).
access:  public


[ Top ]



getAllRootMenus [line 59]

array getAllRootMenus( )

Gets all nodes that have the root as parent.



Tags:

return:  An array with one MenuItem instance for every menu item with root as parent.
access:  private


[ Top ]



insertMenu [line 77]

void insertMenu( )

Inserts the menu from the cache.



Tags:

access:  public


[ Top ]



updateMenuCache [line 33]

void updateMenuCache( )

Updates the cache of the menu. Rebuilds the menu with the currently saved configuration and then rewrites the cache.



Tags:

access:  public


[ Top ]



Documentation generated on Sun, 16 Apr 2006 21:03:37 +0200 by phpDocumentor 1.3.0RC4