Class: HTML_Menu

HTML_Menu HTML_Menu( [array $menu = null], [string $type = 'tree'], [string $urlEnvVar = 'PHP_SELF'])

Initializes the menu, sets the type and menu structure.

Parameters:

void forceCurrentUrl( string $url)

Forces the given URL to be "current"

Parameters:

string get( [string $menuType = ''])

Returns the HTML menu.

Parameters:

string getCurrentURL( )

Returns the URL of the currently selected page.

The returned string is used for all test against the URL's in the menu structure hash.

array getPath( )

Returns the path of the current page in the menu 'tree'.

void render( object HTML_Menu_Renderer &$renderer, [string $menuType = ''])

Renders the menu.

Parameters:

void setMenu( array $menu)

Sets the menu structure.

The menu structure is defined by a multidimensional hash. This is quite "dirty" but simple and easy to traverse. An example show the structure. To get the following menu:

1. - Projects

11 - Projects => PHPDoc 12 - Projects => Forms 2 - Stuff

you need the array:

$menu = array(

1. => array( 'title' => 'Projects', 'url' => '/projects/index.php', 'sub' => array( 11 => array( 'title' => 'PHPDoc', ... ), 12 => array( ... ), ) ),
2. => array( 'title' => 'Stuff', 'url' => '/stuff/index.php' )

)

Note the index 'sub' and the nesting. Note also that 1, 11, 12, 2 must be unique. The class uses them as ID's.

Parameters:

void setMenuType( string $menuType)

Sets the type of the menu.

Available types are: 'tree', 'rows', 'urhere', 'prevnext', 'sitemap'.

Parameters:

void setURLEnvVar( string $urlEnvVar)

Sets the environment variable to use to get the current URL.

Parameters:

void setUrlPrefix( string $prefix)

Sets the prefix for the URLs in the menu

Parameters:

void show( [string $menuType = ''])

Prints the HTML menu.

Parameters: