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

Class: TranslatedPortlet

Source Location: /CORE/system/api/portlet/TranslatedPortlet.php

Class TranslatedPortlet

Class Overview

This is a base class for Portlets that use a ResourceBundle.

For each parameter, you have to give a key.

For example, you have the PortletParameter "foo", you should have a tranlation entry called "param_name_foo".

Located in /CORE/system/api/portlet/TranslatedPortlet.php [line 42]

Portlet
   |
   --TranslatedPortlet

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: TranslatedPortlet.php,v 1.1 2007/04/23 13:02:36 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
LastEditedItemsPortlet	Shows a configurable amount of Items that were last edited in the System.
QuickSearchPortlet	This portlets displas a Quick Search Formular.
NavigationPortlet	Shows a Navigation of one Level.
LoginMaskPortlet	This portlets shows a Login Form.
ToolPortlet	This portlets shows the Application Links in a List.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

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

void	getParameterName()
String	getTranslation()	Gets the Translation fo the given key.
boolean	loadBundle()	Loads the given ResourceBundle for this Portlet.

[ Top ]

Methods

getParameterName [line 72]

void getParameterName(

$key 
)

Parameters:

$key:

Redefinition of:

Portlet::getParameterName(): Returns the Name of the given Parameter.

[ Top ]

getTranslation [line 64]

String getTranslation(

$key, [
$fallback = null] 
)

Gets the Translation fo the given key.

If this is not found or the Bundle is null, it returns fallback.

Parameters:

	$key:
	$fallback:

API Tags:

Return:

the Translation or fallback

[ Top ]

loadBundle [line 53]

boolean loadBundle(

$name 
)

Loads the given ResourceBundle for this Portlet.

Parameters:

$name:

API Tags:

Return:

whether the Bundle could be loaded or not

[ Top ]