[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: NavigationPortlet

Source Location: /CORE/system/classes/portlets/NavigationPortlet.php

Class NavigationPortlet

Class Overview

Shows a Navigation of one Level.

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

Located in /CORE/system/classes/portlets/NavigationPortlet.php [line 65]

Portlet
   |
   --TranslatedPortlet
      |
      --NavigationPortlet

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: NavigationPortlet.php,v 1.11 2008/12/03 12:35:46 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From TranslatedPortlet

TranslatedPortlet::getParameterName()

TranslatedPortlet::getTranslation()

Gets the Translation fo the given key.

TranslatedPortlet::loadBundle()

Loads the given ResourceBundle for this Portlet.

Inherited From Portlet

Portlet::Portlet()

Portlet::displayPortlet()

OPTIONAL TO BE OVERWRITEN!
Return if this Portlet should be displayed or not.

Portlet::getAllParameter()

Gets all configured Portlet Parameter.

Portlet::getHtml()

REQIURED TO BE OVERWRITEN!
Return the HTML snippet that this Portlet represents.

Portlet::getIdentifier()

Get the Identifier for this Portlet.

Portlet::getJavascript()

OPTIONAL TO BE OVERWRITEN!
Overwrite if your Portlet needs a Javascript snippet to work.

Portlet::getParameter()

Gets a Portlet Parameter.

Portlet::getParameterName()

Returns the Name of the given Parameter.

Portlet::getParameterType()

REQIURED TO BE OVERWRITEN!
Returns the PortletType for the given Key.

Portlet::getTitle()

REQIURED TO BE OVERWRITEN!
Return the Title for this Portlet.

Portlet::needsJavascript()

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

Portlet::setParameter()

Sets a Portlet Parameter.

[ Top ]

Method Summary

NavigationPortlet	NavigationPortlet()
void	buildMenuLevel()
void	displayPortlet()
void	getCSS()
void	getHtml()
void	getIdentifier()
void	getIncludeHome()
void	getLanguageID()
void	getLevel()
void	getParameterType()
void	getStartID()
void	getTitle()	Returns the Title of this Portlet.
void	needsJavascript()
void	setCSS()	Set the CSS Class for the Menu List.
void	setIncludeHome()
void	setLanguageID()	Sets the Language for the Tree to be fetched.
void	setLevel()
void	setStartID()	Set the ID for the Tree to be fetched.
void	setTitle()	Set the Title of this Portlet.

[ Top ]

Methods

Constructor NavigationPortlet [line 72]

NavigationPortlet NavigationPortlet(
)

[ Top ]

buildMenuLevel [line 156]

void buildMenuLevel(

$id, 
$langid, 
$level 
)

Parameters:

	$id:
	$langid:
	$level:

[ Top ]

displayPortlet [line 122]

void displayPortlet(
)

Redefinition of:

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

[ Top ]

getCSS [line 173]

void getCSS(
)

[ Top ]

getHtml [line 148]

void getHtml(
)

Redefinition of:

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

[ Top ]

getIdentifier [line 85]

void getIdentifier(
)

Redefinition of:

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

[ Top ]

getIncludeHome [line 218]

void getIncludeHome(
)

[ Top ]

getLanguageID [line 207]

void getLanguageID(
)

[ Top ]

getLevel [line 226]

void getLevel(
)

[ Top ]

getParameterType [line 89]

void getParameterType(

$key 
)

Parameters:

$key:

Redefinition of:

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

[ Top ]

getStartID [line 192]

void getStartID(
)

[ Top ]

getTitle [line 118]

void getTitle(
)

Returns the Title of this Portlet.

Redefinition of:

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

[ Top ]

needsJavascript [line 152]

void needsJavascript(
)

Redefinition of:

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

[ Top ]

setCSS [line 180]

void setCSS(
[
$css = ''] 
)

Set the CSS Class for the Menu List.

Parameters:

$css:

[ Top ]

setIncludeHome [line 214]

void setIncludeHome(

$includeHome 
)

Parameters:

$includeHome:

[ Top ]

setLanguageID [line 203]

void setLanguageID(
[
$id = ''] 
)

Sets the Language for the Tree to be fetched.

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

Parameters:

$id:

[ Top ]

setLevel [line 222]

void setLevel(

$level 
)

Parameters:

$level:

[ Top ]

setStartID [line 188]

void setStartID(
[
$id = ''] 
)

Set the ID for the Tree to be fetched.

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

Parameters:

$id:

[ Top ]

setTitle [line 111]

void setTitle(

$title 
)

Set the Title of this Portlet.

Parameters:

$title:

[ Top ]