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

Class: AdminMenuItem

Source Location: /CORE/system/classes/administration/AdminMenuItem.php

Class AdminMenuItem

Class Overview

Class used for admin Menu wrapper.

Represents a Admin TOP LEVEL Menu.

Note: There are two kind of Admin Menus, TOP Level and direct Childs. There is no plan for the future to add deeper Menus Structures.

Located in /CORE/system/classes/administration/AdminMenuItem.php [line 42]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: AdminMenuItem.php,v 1.6 2009/03/13 01:57:26 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
AdminMenuItemDynamic	Class used for admin Menu wrapper.
AdminSubMenu	DEPRECATED!!! Use AdminMenuItem instead!!!!

[ Top ]

Method Summary

AdminMenuItem	AdminMenuItem()	Initializes this Menu with the Settings of the given ID.
void	checkPermissions()
void	getConfig()	Returns the Config setting of this Admin Plugin.
void	getDescription()	Get the translated Description for this Menu. This can be a longer text, exactly saying what this PlugIn is meant for and other real important usage information.
void	getFileName()	Get the File Name for this PlugIn.
void	getID()	Returns the Menu ID. Used to build Administration Links.
void	getName()	Get the translated Menu Name.
void	getPath()	Get the Path of this Menu.
void	getPermissions()
void	getTitle()	Get the translated Title for this Menu. Title is most often a one-sentence info message about this Administration PlugIn.
void	isHidden()	Returns whether this Menu (dynamic menus can use of this) should be shown in the Navigation.
void	isTranslated()	This indicates whether this PlugIn is translated or not.
void	loadTranslation()
void	loadTranslationForMenu()	This indicates whether this PlugIn should load the PlugIns translation File for displaying the Menus Name and Mouse-Over description within the Navigation Frame.

[ Top ]

Methods

Constructor AdminMenuItem [line 56]

AdminMenuItem AdminMenuItem(

$values, 
$parent 
)

Initializes this Menu with the Settings of the given ID.

Parameters:

	$values:
	$parent:

[ Top ]

checkPermissions [line 214]

void checkPermissions(

$userID 
)

Parameters:

$userID:

[ Top ]

getConfig [line 174]

void getConfig(

$key 
)

Returns the Config setting of this Admin Plugin.

The settings are configured in the Plugin INI File. Returns null if the key could not be found.

Parameters:

$key:

[ Top ]

getDescription [line 133]

void getDescription(
)

Get the translated Description for this Menu. This can be a longer text, exactly saying what this PlugIn is meant for and other real important usage information.

The Description should not be longer than about 200 to 300 Character.

[ Top ]

getFileName [line 157]

void getFileName(
)

Get the File Name for this PlugIn.

[ Top ]

getID [line 140]

void getID(
)

Returns the Menu ID. Used to build Administration Links.

[ Top ]

getName [line 116]

void getName(
)

Get the translated Menu Name.

[ Top ]

getPath [line 165]

void getPath(
)

Get the Path of this Menu.

Can be used to find Includes and other Ressources within the File System.

[ Top ]

getPermissions [line 210]

void getPermissions(
)

[ Top ]

getTitle [line 124]

void getTitle(
)

Get the translated Title for this Menu. Title is most often a one-sentence info message about this Administration PlugIn.

[ Top ]

isHidden [line 148]

void isHidden(
)

Returns whether this Menu (dynamic menus can use of this) should be shown in the Navigation.

[ Top ]

isTranslated [line 188]

void isTranslated(
)

This indicates whether this PlugIn is translated or not.

The Administration Framework loads the PlugIns translation File itself, you do not have to care about that!

Administration Main Menus are virtual directorys and therefor never translated by own Files.

[ Top ]

loadTranslation [line 194]

void loadTranslation(
)

Redefined in descendants as:

AdminMenuItemDynamic::loadTranslation()

[ Top ]

loadTranslationForMenu [line 204]

void loadTranslationForMenu(
)

This indicates whether this PlugIn should load the PlugIns translation File for displaying the Menus Name and Mouse-Over description within the Navigation Frame.

Administration Main Menus are virtual directorys and therefor never translated by own Files.

[ Top ]