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

Class: HTML_Menu_Renderer

Source Location: /HTML_Menu-2.1.4/Menu/Renderer.php

Class Overview


Abstract base class for HTML_Menu renderers


Author(s):

Version:

  • Release: 2.1.4

Methods


Child classes:

HTML_Menu_SigmaRenderer
The renderer that uses HTML_Template_Sigma instance for menu output.
HTML_Menu_DirectTreeRenderer
The 'direct' renderer for 'tree' and 'sitemap' menu types where level is represented by tags nesting.
HTML_Menu_ArrayRenderer
The renderer that creates an array of visible menu entries.
HTML_Menu_SigmaTreeRenderer
HTML_Template_Sigma-based renderer for 'tree' and 'sitemap' type menus, where menu level is represented by tag nesting.
HTML_Menu_DirectRenderer
The renderer that generates HTML for the menu all by itself.

Inherited Variables

Inherited Methods


Class Details

[line 31]
Abstract base class for HTML_Menu renderers
  • Author: Alexey Borzov <avb@php.net>
  • Version: Release: 2.1.4
  • Abstract:


[ Top ]


Method Detail

finishLevel   [line 75]

void finishLevel( int $level)

Finish the tree level (for types 'tree' and 'sitemap')
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_Menu_DirectTreeRenderer::finishLevel()
HTML_Menu_SigmaTreeRenderer::finishLevel()

Parameters:

int   $level   —  current depth in the tree structure

[ Top ]

finishMenu   [line 63]

void finishMenu( int $level)

Finish the menu
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_Menu_SigmaRenderer::finishMenu()
HTML_Menu_ArrayRenderer::finishMenu()
HTML_Menu_DirectRenderer::finishMenu()

Parameters:

int   $level   —  current depth in the tree structure

[ Top ]

finishRow   [line 87]

void finishRow( int $level)

Finish the row in the menu
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_Menu_SigmaRenderer::finishRow()
HTML_Menu_DirectRenderer::finishRow()

Parameters:

int   $level   —  current depth in the tree structure

[ Top ]

renderEntry   [line 101]

void renderEntry( array $node, int $level, int $type)

Renders the element of the menu
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_Menu_SigmaRenderer::renderEntry()
HTML_Menu_DirectTreeRenderer::renderEntry()
HTML_Menu_ArrayRenderer::renderEntry()
HTML_Menu_SigmaTreeRenderer::renderEntry()
HTML_Menu_DirectRenderer::renderEntry()

Parameters:

array   $node   —  Element being rendered
int   $level   —  Current depth in the tree structure
int   $type   —  Type of the element (one of HTML_MENU_ENTRY_* constants)

[ Top ]

setMenuType   [line 50]

void setMenuType( string $menuType)

Sets the type of the menu being rendered.

This method will throw an error if the renderer is not designed to render a specific menu type.

  • Throws: PEAR_Error
  • Access: public

Overridden in child classes as:

HTML_Menu_DirectTreeRenderer::setMenuType()
HTML_Menu_SigmaTreeRenderer::setMenuType()

Parameters:

string   $menuType   —  menu type

[ Top ]


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