Docs For Class NavigationPortlet

Description

Shows a Navigation of one Level.

The Portlet can be configured with multiple values. The default CSS class is "navigationPortlet".

author: Kevin Papst
version: $Id: NavigationPortlet.php,v 1.5 2007/04/23 13:03:12 kpapst Exp $
copyright: Copyright (C) Kevin Papst
license: GNU Public License

Portlet
   |
   --TranslatedPortlet
      |
      --NavigationPortlet

Method Summary

NavigationPortlet NavigationPortlet ()

void buildMenuLevel ( $id, $langid)

void displayPortlet ()

void getCSS ()

void getHtml ()

void getIdentifier ()

void getLanguageID ()

void getParameterType ( $key)

void getStartID ()

void getTitle ()

void hideIfEmpty ()

void needsJavascript ()

void setCSS ([ $css = ''])

void setHideIfEmpty ([boolean $hide = false])

void setLanguageID ([ $id = ''])

void setStartID ([ $id = ''])

void setTitle ( $title)

Methods

Constructor NavigationPortlet (line 67)

NavigationPortlet NavigationPortlet ()

buildMenuLevel (line 145)

void buildMenuLevel ( $id, $langid)

$id
$langid

displayPortlet (line 114)

void displayPortlet ()

Redefinition of:

Portlet::displayPortlet(): OPTIONAL TO BE OVERWRITEN!
Return if this Portlet should be displayed or not.

getCSS (line 177)

void getCSS ()

getHtml (line 134)

void getHtml ()

Redefinition of:

Portlet::getHtml(): REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

getIdentifier (line 79)

void getIdentifier ()

Redefinition of:

Portlet::getIdentifier(): Get the Identifier for this Portlet.

getLanguageID (line 211)

void getLanguageID ()

getParameterType (line 83)

void getParameterType ( $key)

$key

Redefinition of:

Portlet::getParameterType(): REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

getStartID (line 196)

void getStartID ()

getTitle (line 110)

Returns the Title of this Portlet.

void getTitle ()

Redefinition of:

Portlet::getTitle(): REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

hideIfEmpty (line 165)

void hideIfEmpty ()

needsJavascript (line 141)

void needsJavascript ()

Redefinition of:

Portlet::needsJavascript(): OPTIONAL TO BE OVERWRITEN!
This method defines if the Portlet needs a Javascript block to work.

setCSS (line 184)

Set the CSS Class for the Menu List.

void setCSS ([ $css = ''])

$css

setHideIfEmpty (line 173)

If true is passed, the Portlet will not be displayed if no children can be fetched.

void setHideIfEmpty ([boolean $hide = false])

boolean $hide: hide whether the Portlet should be displayed if no children can be found

setLanguageID (line 207)

Sets the Language for the Tree to be fetched.

If none (empty String) is passed, it uses the current Menu Language ID.

void setLanguageID ([ $id = ''])

$id

setStartID (line 192)

Set the ID for the Tree to be fetched.

If none (empty String) is passed, it uses the current Menu ID.

void setStartID ([ $id = ''])

$id

setTitle (line 103)

Set the Title of this Portlet.

void setTitle ( $title)

$title

Inherited Methods

Inherited From TranslatedPortlet

TranslatedPortlet::getParameterName()
TranslatedPortlet::getTranslation()
TranslatedPortlet::loadBundle()

Inherited From Portlet

Portlet::Portlet()
Portlet::displayPortlet()
Portlet::getAllParameter()
Portlet::getHtml()
Portlet::getIdentifier()
Portlet::getJavascript()
Portlet::getParameter()
Portlet::getParameterName()
Portlet::getParameterType()
Portlet::getTitle()
Portlet::needsJavascript()
Portlet::setParameter()