HTML_Menu
PEAR Manual
PrevChapter 41. HTMLNext

HTML_Menu

Table of Contents
Introduction -- Menu structure and supported output modes
constructor HTML_Menu::HTML_Menu() -- Initializes the menu, sets the type and menu structure.
HTML_Menu::forceCurrentUrl() -- Forces the given URL to be "current"
HTML_Menu::get() -- Returns the HTML menu.
HTML_Menu::getCurrentURL() -- Returns the URL of the currently selected page.
HTML_Menu::getPath() -- Returns the path of the current page in the menu 'tree'.
HTML_Menu::render() -- Renders the menu.
HTML_Menu::setMenu() -- Sets the menu structure.
HTML_Menu::setMenuType() -- Sets the type of the menu.
HTML_Menu::setURLEnvVar() -- Sets the environment variable to use to get the current URL.
HTML_Menu::setURLPrefix() -- Sets the prefix for the URLs in the menu
HTML_Menu::show() -- Prints the HTML menu.
Class Summary HTML_Menu_Renderer -- An abstract base class for HTML_Menu renderers (package developer related)
HTML_Menu_Renderer::finishLevel() -- Finish the tree level (for types 'tree' and 'sitemap') (package developer related)
HTML_Menu_Renderer::finishMenu() -- Finish the menu (package developer related)
HTML_Menu_Renderer::finishRow() -- Finish the row in the menu (package developer related)
HTML_Menu_Renderer::renderEntry() -- Renders the element of the menu (package developer related)
HTML_Menu_Renderer::setMenuType() -- Sets the type of the menu being rendered
Class Summary HTML_Menu_DirectRenderer -- The renderer that generates HTML for the menu all by itself.
DirectRenderer::setEntryTemplate() -- Sets the template for menu entry.
DirectRenderer::setMenuTemplate() -- Sets the menu template (HTML that wraps around rows)
DirectRenderer::setRowTemplate() -- Sets the row template (HTML that wraps around entries)
DirectRenderer::toHtml() -- returns the HTML generated for the menu
Class Summary HTML_Menu_DirectTreeRenderer -- The "direct" renderer for 'tree' and 'sitemap' menu types where level is represented by tags nesting.
DirectTreeRenderer::setEntryTemplate() -- Sets the template for menu entry.
DirectTreeRenderer::setItemTemplate() -- Sets the item template (HTML that wraps around entries)
DirectTreeRenderer::setLevelTemplate() -- Sets the level template (HTML that wraps around the submenu)
DirectTreeRenderer::toHtml() -- returns the HTML generated for the menu
Class Summary HTML_Menu_ArrayRenderer -- The renderer that creates an array of visible menu entries.
ArrayRenderer::toArray() -- returns the resultant array
Class Summary HTML_Menu_SigmaRenderer -- The renderer that uses HTML_Template_Sigma instance for menu output.
constructor HTML_Menu_SigmaRenderer() -- Class constructor.
Class Summary HTML_Menu_SigmaTreeRenderer -- HTML_Template_Sigma-based renderer for 'tree' and 'sitemap' type menus, where menu level is represented by tag nesting.
constructor HTML_Menu_SigmaTreeRenderer() -- Class constructor.
Class Summary HTML_MenuBrowser -- Simple filesystem browser that can be used to generated menu (3) hashes based on the directory structure.
constructor HTML_MenuBrowser::HTML_MenuBrowser() -- Creates the object and optionally sets the directory to scan.
HTML_MenuBrowser::addFileInfo() -- Adds further informations to the menu hash gathered from the files in it
HTML_MenuBrowser::browse() -- Recursive function that does the scan and builds the menu (3) hash.
HTML_MenuBrowser::exploreFile() -- Returns additional menu informations decoded in the file that appears in the menu.
HTML_MenuBrowser::getMenu() -- Returns a hash to be used with menu(3)'s setMenu().
HTML_MenuBrowser::setDirectory() -- Sets the directory to scan.
HTML_MenuBrowser::setIDPrefix() -- Sets the prefix for every id in the menu hash.
Package HTML_Menu Constants -- Constants defined in and used by HTML_Menu

With the HTML_Menu class one can easily create and maintain a navigation structure for websites, configuring it via a multidimensional hash structure. Different modes for the HTML output are supported.

PrevHomeNext
Usage examplesUpIntroduction