HTML_Menu
[ class tree: HTML_Menu ] [ index: HTML_Menu ] [ all elements ]

Element index for package HTML_Menu

[ a ] [ b ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ r ] [ s ] [ t ]

a

addFileInfo
in file MenuBrowser.php, method HTML_MenuBrowser::addFileInfo()
    Adds further informations to the menu hash gathered from the files in it
ArrayRenderer.php
procedural page ArrayRenderer.php
top

b

browse
in file MenuBrowser.php, method HTML_MenuBrowser::browse()
    Recursive function that does the scan and builds the menu (3) hash.
top

d

$dir
in file MenuBrowser.php, variable HTML_MenuBrowser::$dir
    Directory to scan.
DirectRenderer.php
procedural page DirectRenderer.php
DirectTreeRenderer.php
procedural page DirectTreeRenderer.php
top

e

exploreFile
in file MenuBrowser.php, method HTML_MenuBrowser::exploreFile()
    Returns additional menu informations decoded in the file that appears in the menu.
top

f

$file_suffix
in file MenuBrowser.php, variable HTML_MenuBrowser::$file_suffix
    Filesuffix of your XML files.
$file_suffix_length
in file MenuBrowser.php, variable HTML_MenuBrowser::$file_suffix_length
    Number of characters of the file suffix.
finishLevel
in file Renderer.php, method HTML_Menu_Renderer::finishLevel()
    Finish the tree level (for types 'tree' and 'sitemap')
finishLevel
in file SigmaTreeRenderer.php, method HTML_Menu_SigmaTreeRenderer::finishLevel()
finishLevel
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::finishLevel()
finishMenu
in file Renderer.php, method HTML_Menu_Renderer::finishMenu()
    Finish the menu
finishMenu
in file SigmaRenderer.php, method HTML_Menu_SigmaRenderer::finishMenu()
finishMenu
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::finishMenu()
finishMenu
in file ArrayRenderer.php, method HTML_Menu_ArrayRenderer::finishMenu()
finishRow
in file SigmaRenderer.php, method HTML_Menu_SigmaRenderer::finishRow()
finishRow
in file Renderer.php, method HTML_Menu_Renderer::finishRow()
    Finish the row in the menu
finishRow
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::finishRow()
forceCurrentIndex
in file Menu.php, method HTML_Menu::forceCurrentIndex()
    Forces the menu item with the given index to become "current"
forceCurrentUrl
in file Menu.php, method HTML_Menu::forceCurrentUrl()
    Forces the given URL to be "current"
top

g

get
in file Menu.php, method HTML_Menu::get()
    Returns the HTML menu.
getCurrentURL
in file Menu.php, method HTML_Menu::getCurrentURL()
    Returns the URL of the currently selected page.
getMenu
in file MenuBrowser.php, method HTML_MenuBrowser::getMenu()
    Returns a hash to be used with menu(3)'s setMenu().
getPath
in file Menu.php, method HTML_Menu::getPath()
    Returns the path of the current page in the menu 'tree'.
top

h

HTML_Menu
in file Menu.php, class HTML_Menu
    Generates a HTML menu from a multidimensional hash.
HTML_Menu
in file Menu.php, method HTML_Menu::HTML_Menu()
    Initializes the menu, sets the type and menu structure.
HTML_MenuBrowser
in file MenuBrowser.php, method HTML_MenuBrowser::HTML_MenuBrowser()
    Creates the object and optionally sets the directory to scan.
HTML_MenuBrowser
in file MenuBrowser.php, class HTML_MenuBrowser
    Simple filesystem browser that can be used to generate menu (3) hashes based on the directory structure.
HTML_Menu_ArrayRenderer
in file ArrayRenderer.php, class HTML_Menu_ArrayRenderer
    The renderer that creates an array of visible menu entries.
HTML_Menu_DirectRenderer
in file DirectRenderer.php, class HTML_Menu_DirectRenderer
    The renderer that generates HTML for the menu all by itself.
HTML_Menu_DirectTreeRenderer
in file DirectTreeRenderer.php, class HTML_Menu_DirectTreeRenderer
    The 'direct' renderer for 'tree' and 'sitemap' menu types where level is represented by tags nesting.
HTML_MENU_ENTRY_ACTIVE
in file Menu.php, constant HTML_MENU_ENTRY_ACTIVE
    Constants for menu entry types
HTML_MENU_ENTRY_ACTIVEPATH
in file Menu.php, constant HTML_MENU_ENTRY_ACTIVEPATH
    Constants for menu entry types
HTML_MENU_ENTRY_BREADCRUMB
in file Menu.php, constant HTML_MENU_ENTRY_BREADCRUMB
    Constants for menu entry types
HTML_MENU_ENTRY_INACTIVE
in file Menu.php, constant HTML_MENU_ENTRY_INACTIVE
    Constants for menu entry types
HTML_MENU_ENTRY_NEXT
in file Menu.php, constant HTML_MENU_ENTRY_NEXT
    Constants for menu entry types
HTML_MENU_ENTRY_PREVIOUS
in file Menu.php, constant HTML_MENU_ENTRY_PREVIOUS
    Constants for menu entry types
HTML_MENU_ENTRY_UPPER
in file Menu.php, constant HTML_MENU_ENTRY_UPPER
    Constants for menu entry types
HTML_Menu_Renderer
in file Renderer.php, class HTML_Menu_Renderer
    Abstract base class for HTML_Menu renderers
HTML_Menu_SigmaRenderer
in file SigmaRenderer.php, method HTML_Menu_SigmaRenderer::HTML_Menu_SigmaRenderer()
    Class constructor.
HTML_Menu_SigmaRenderer
in file SigmaRenderer.php, class HTML_Menu_SigmaRenderer
    The renderer that uses HTML_Template_Sigma instance for menu output.
HTML_Menu_SigmaTreeRenderer
in file SigmaTreeRenderer.php, method HTML_Menu_SigmaTreeRenderer::HTML_Menu_SigmaTreeRenderer()
    Class constructor.
HTML_Menu_SigmaTreeRenderer
in file SigmaTreeRenderer.php, class HTML_Menu_SigmaTreeRenderer
    HTML_Template_Sigma-based renderer for 'tree' and 'sitemap' type menus, where menu level is represented by tag nesting.
top

i

$id_prefix
in file MenuBrowser.php, variable HTML_MenuBrowser::$id_prefix
    Prefix for every menu hash entry.
$index
in file MenuBrowser.php, variable HTML_MenuBrowser::$index
    Filename (without suffix) of your index / start pages.
$index_file
in file MenuBrowser.php, variable HTML_MenuBrowser::$index_file
    Full filename of your index / start pages.
top

m

$menu
in file MenuBrowser.php, variable HTML_MenuBrowser::$menu
    Menu (3)'s setMenu() hash.
Menu.php
procedural page Menu.php
MenuBrowser.php
procedural page MenuBrowser.php
top

r

Renderer.php
procedural page Renderer.php
render
in file Menu.php, method HTML_Menu::render()
    Renders the menu.
renderEntry
in file SigmaRenderer.php, method HTML_Menu_SigmaRenderer::renderEntry()
renderEntry
in file SigmaTreeRenderer.php, method HTML_Menu_SigmaTreeRenderer::renderEntry()
renderEntry
in file Renderer.php, method HTML_Menu_Renderer::renderEntry()
    Renders the element of the menu
renderEntry
in file ArrayRenderer.php, method HTML_Menu_ArrayRenderer::renderEntry()
renderEntry
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::renderEntry()
renderEntry
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::renderEntry()
top

s

SigmaRenderer.php
procedural page SigmaRenderer.php
SigmaTreeRenderer.php
procedural page SigmaTreeRenderer.php
setDirectory
in file MenuBrowser.php, method HTML_MenuBrowser::setDirectory()
    Sets the directory to scan.
setEntryTemplate
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::setEntryTemplate()
    Sets the template for menu entry.
setEntryTemplate
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::setEntryTemplate()
    Sets the template for menu entry.
setIDPrefix
in file MenuBrowser.php, method HTML_MenuBrowser::setIDPrefix()
    Sets the prefix for every id in the menu hash.
setItemTemplate
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::setItemTemplate()
    Sets the item template (HTML that wraps around entries)
setLevelTemplate
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::setLevelTemplate()
    Sets the level template (HTML that wraps around the submenu)
setMenu
in file Menu.php, method HTML_Menu::setMenu()
    Sets the menu structure.
setMenuTemplate
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::setMenuTemplate()
    Sets the menu template (HTML that wraps around rows)
setMenuType
in file SigmaTreeRenderer.php, method HTML_Menu_SigmaTreeRenderer::setMenuType()
setMenuType
in file Renderer.php, method HTML_Menu_Renderer::setMenuType()
    Sets the type of the menu being rendered.
setMenuType
in file Menu.php, method HTML_Menu::setMenuType()
    Sets the type of the menu.
setMenuType
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::setMenuType()
setRowTemplate
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::setRowTemplate()
    Sets the row template (HTML that wraps around entries)
setURLEnvVar
in file Menu.php, method HTML_Menu::setURLEnvVar()
    Sets the environment variable to use to get the current URL.
setUrlPrefix
in file Menu.php, method HTML_Menu::setUrlPrefix()
    Sets the prefix for the URLs in the menu
show
in file Menu.php, method HTML_Menu::show()
    Prints the HTML menu.
top

t

toArray
in file ArrayRenderer.php, method HTML_Menu_ArrayRenderer::toArray()
    Returns the resultant array
toHtml
in file DirectTreeRenderer.php, method HTML_Menu_DirectTreeRenderer::toHtml()
    returns the HTML generated for the menu
toHtml
in file DirectRenderer.php, method HTML_Menu_DirectRenderer::toHtml()
    returns the HTML generated for the menu
top

Documentation generated on Mon, 11 Mar 2019 15:02:05 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.