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

Class: AdminMenu

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

Class AdminMenu

Class Overview

This represents a Admin Menu, a type of Admin Category!

Located in /CORE/system/classes/administration/AdminMenu.php [line 38]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: AdminMenu.php,v 1.14 2007/06/12 00:06:38 kpapst Exp $
Copyright:	Copyright (C) Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Method Summary

AdminMenu	AdminMenu()	Initializes this Menu with the Settings of the given ID.
void	addChild()
void	getChildNames()
void	getChilds()	Returns an Array of the Menu Child IDs.
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	getID()	Returns the Menu ID. Used to build Administration Links.
void	getName()	Get the translated Menu Name.
void	getPath()	Returns the Path of the Menu.
void	getTitle()	Get the translated Title for this Menu. Title is most often a one-sentence info message about this Administration PlugIn.
void	hasChilds()	Returns whether this Menu has Childs or not.
void	isDynamic()	Returns whether the Menu uses dynamic Items or not.

[ Top ]

Methods

Constructor AdminMenu [line 53]

AdminMenu AdminMenu(

$values 
)

Initializes this Menu with the Settings of the given ID.

Parameters:

$values:

[ Top ]

addChild [line 112]

void addChild(

$child 
)

Parameters:

$child:

[ Top ]

getChildNames [line 116]

void getChildNames(
)

[ Top ]

getChilds [line 108]

void getChilds(
)

Returns an Array of the Menu Child IDs.

[ Top ]

getConfig [line 132]

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 94]

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 ]

getID [line 101]

void getID(
)

Returns the Menu ID. Used to build Administration Links.

[ Top ]

getName [line 77]

void getName(
)

Get the translated Menu Name.

[ Top ]

getPath [line 63]

void getPath(
)

Returns the Path of the Menu.

[ Top ]

getTitle [line 85]

void getTitle(
)

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

[ Top ]

hasChilds [line 123]

void hasChilds(
)

Returns whether this Menu has Childs or not.

[ Top ]

isDynamic [line 70]

void isDynamic(
)

Returns whether the Menu uses dynamic Items or not.

[ Top ]