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

Class: Modul

Source Location: /CORE/system/classes/modul/Modul.php

Class Modul

Class Overview

This represents a BIGACE module.

Located in /CORE/system/classes/modul/Modul.php [line 38]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: Modul.php,v 1.22 2008/11/30 17:02:10 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Method Summary

Modul	Modul()
void	getConfiguration()	Returns the Configuration of this Modul as Array.
void	getDescription()	Returns the translated description of this Modul.
String	getFullURL()	Get the Full URL of the Modul. This is the URL to the Moduls PHP File.
String	getID()	Get the Unique ID of this Modul.
void	getName()	Returns the translated name of this module.
void	getPath()	Get the Path to this Modul.
void	getTitle()	Returns the translated title of this Modul.
ResourceBundle	getTranslation()	Returns the moduls ResourceBundle.
void	getVersion()	Returns the version of this Modul or MODUL_DEFAULT_VERSION
boolean	isActivated()	Returns whether this Modul is activated for the current Community or not.
void	isModulAdmin()	Checks if the actual User is a potential Modul Admin.
void	isTranslated()	Returns whether this Modul is translated.
void	translate()	Get a translation from the Moduls own translation.

[ Top ]

Methods

Constructor Modul [line 46]

Modul Modul(

$id 
)

Parameters:

$id:

[ Top ]

getConfiguration [line 198]

void getConfiguration(
)

Returns the Configuration of this Modul as Array.

[ Top ]

getDescription [line 157]

void getDescription(
)

Returns the translated description of this Modul.

[ Top ]

getFullURL [line 174]

String getFullURL(
)

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

API Tags:

Return:

the full qualified URL to the File

[ Top ]

getID [line 165]

String getID(
)

Get the Unique ID of this Modul.

API Tags:

Return:

the ID of this Modul

[ Top ]

getName [line 143]

void getName(
)

Returns the translated name of this module.

If you want to have the Name in a different language, call

loadTranslation($locale)

before.

[ Top ]

getPath [line 181]

void getPath(
)

Get the Path to this Modul.

[ Top ]

getTitle [line 150]

void getTitle(
)

Returns the translated title of this Modul.

[ Top ]

getTranslation [line 108]

ResourceBundle getTranslation(
[
$locale = null] 
)

Returns the moduls ResourceBundle.

Added with 2.5.

Parameters:

$locale:

API Tags:

Return:

or null

[ Top ]

getVersion [line 205]

void getVersion(
)

Returns the version of this Modul or MODUL_DEFAULT_VERSION

[ Top ]

isActivated [line 189]

boolean isActivated(
)

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

API Tags:

Return:

whether this Modul can be used in Menus or not

[ Top ]

isModulAdmin [line 213]

void isModulAdmin(
)

Checks if the actual User is a potential Modul Admin.

This check depends on a Functional right check!

[ Top ]

isTranslated [line 99]

void isTranslated(
)

Returns whether this Modul is translated.

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

[ Top ]

translate [line 130]

void translate(

$key, [
$fallback = null] 
)

Get a translation from the Moduls own translation.

Parameters:

	$key:
	$fallback:

[ Top ]