- Introduction
- Constructor
- forceCurrentUrl()
- get()
- getCurrentURL()
- getPath()
- render()
- setMenu()
- setMenuType()
- setURLEnvVar()
- setURLPrefix()
- show()
- Class Summary
HTML_Menu_Renderer - Class Summary
HTML_Menu_DirectRenderer - DirectRenderer::
setEntryTemplate() - DirectRenderer::
setMenuTemplate() - DirectRenderer::
setRowTemplate() - DirectRenderer::toHtml()
- Class Summary
HTML_Menu_DirectTreeRend
erer - DirectTreeRenderer::
setEntryTemplate() - DirectTreeRenderer::
setItemTemplate() - DirectTreeRenderer::
setLevelTemplate() - DirectTreeRenderer::
toHtml() - Class Summary
HTML_Menu_ArrayRenderer - Class Summary
HTML_Menu_SigmaRenderer - Class Summary
HTML_Menu_SigmaTreeRende
rer - Class Summary
HTML_MenuBrowser
Class Summary HTML_Menu_SigmaTreeRenderer
'tree' and 'sitemap' type menus, where menu level is represented by tag nesting.Description
The renderer generates outpu similar to that of HTML_Menu_DirectTreeRenderer but offers more possibilites for output customization.
The renderer may also work with HTML_Template_IT instance, but as menu templates tend to have lots of blocks, HTML_Template_Sigma's cache feature will give a significant performance improvement.
Template structure
This is the minimal template for HTML_Menu_SigmaTreeRenderer, containing all the required blocks:
<!-- BEGIN mu_tree_loop -->
<!-- BEGIN mu_level_open -->
<ul>
<!-- END mu_level_open -->
<!-- BEGIN mu_entry_open -->
<li>
<!-- END mu_entry_open -->
<!-- BEGIN mu_active -->
<strong>{mu_title}</strong>
<!-- END mu_active -->
<!-- BEGIN mu_inactive -->
<a href="{mu_url}">{mu_title}</a>
<!-- END mu_inactive -->
<!-- BEGIN mu_activepath -->
<a href="{mu_url}"><em>{mu_title}</em></a>
<!-- END mu_activepath -->
<!-- BEGIN mu_entry_close -->
</li>
<!-- END mu_entry_close -->
<!-- BEGIN mu_level_close -->
</ul>
<!-- END mu_level_close -->
<!-- END mu_tree_loop -->
A more complete example showing possible customizations can be found in the package archive.
Note that blocks and placeholders in the template have mu_ prefix.
This is done to prevent name conflicts with existing blocks and placeholders, mu_ is
the default prefix, another prefix can be passed to class constructor.
tree_loopThis block should always be present and should be a parent for all other blocks. It is used to implement "flow", to render entries one after another.
level_open,level_closeThese blocks will be used on start and end of each menu level. If level-specific blocks
%level%_level_openand%level%_level_closeare present, they will be used instead.
entry_open,entry_closeThese blocks will be used on start and end of each menu entry. If level-specific blocks
%level%_entry_openand%level%_entry_closeare present, they will be used instead.
inactive,active,activepathThese blocks are used to output menu entries, they correspond to possible entry types. Each block should contain a
{title}placeholder and may also contain{url}placeholder. As usual, if other keys are present in original menu array they will be assigned to corresponding placeholders in the template.If level-specific block
%level%_%entry type%exists, it will be used instead.
Class Trees for HTML_Menu_SigmaTreeRenderer
HTML_Menu_SigmaTreeRenderer
HTML_Menu_SigmaTreeRenderer Inherited Methods
| Method Name | Summary |
|---|---|
| HTML_Menu_Renderer::finishLevel() | Finish the tree level (for types 'tree' and 'sitemap') |
| HTML_Menu_Renderer::finishMenu() | Finish the menu |
| HTML_Menu_Renderer::finishRow() | Finish the row in the menu |
| HTML_Menu_Renderer::renderEntry() | Renders the element of the menu |
| HTML_Menu_Renderer::setMenuType() | Sets the type of the menu being rendered. |
- English