Docs For Class Modul

Description

This should be used to handle a BIGACE Module.

version: $Id: Modul.php,v 1.10 2006/11/26 22:04:14 kpapst Exp $
copyright: Copyright (C) 2002-2006 Kevin Papst
author: Kevin Papst
license: GNU Public License

Method Summary

Modul Modul ( $id)

void getConfiguration ()

void getDescription ()

String getFullURL ()

String getID ()

void getName ()

void getPath ()

void getTitle ()

boolean isActivated ()

void isModulAdmin ()

void isTranslated ()

void translate ( $key)

Methods

Constructor Modul (line 50)

Modul Modul ( $id)

$id

getConfiguration (line 152)

Returns the Configuration of this Modul as Array.

void getConfiguration ()

getDescription (line 102)

Returns the translated description of this Modul.

void getDescription ()

getFullURL (line 128)

Get the Full URL of the Modul. This is the URL to the Moduls PHP File.

return: the full qualified URL to the File

String getFullURL ()

getID (line 119)

Get the Unique ID of this Modul.

return: the ID of this Modul

String getID ()

getName (line 88)

Returns the translated name of this Modul.

If you want to have the Name in a different language, try to load this by calling

loadTranslation($locale)

.

void getName ()

getPath (line 135)

Get the Path to this Modul.

void getPath ()

getTitle (line 95)

Returns the translated title of this Modul.

void getTitle ()

isActivated (line 143)

Returns whether this Modul is activated for the current Community or not.

return: whether this Modul can be used in Menus or not

boolean isActivated ()

isModulAdmin (line 160)

Checks if the actual User is a potential Modul Admin.

This check depends on a Functional right check!

void isModulAdmin ()

isTranslated (line 111)

Returns whether this Modul is translated.

If it is translated, the Language File "translation" will be automatically loaded into the Global Namespace.

void isTranslated ()

translate (line 79)

Get a translation from the Moduls own translation.

void translate ( $key)

$key