ModuleMenu Class Reference

List of all members.

Public Member Functions
	__construct ()
	setBackPath ($backPath)
	getModuleData ($params, $ajaxObj)
	getLoadedModules ()
	saveMenuState ($params, $ajaxObj)
	getRawModuleData ()
	renderLogoutButton ()
	setLinkModules ($linkModules)
Protected Member Functions
	getCollapsedStates ()
	getModuleIcon ($moduleKey)
	getModuleIconAbsolute ($iconFilename)
	getModuleIconRelative ($iconFilename)
	appendQuestionmarkToLink ($link)
Protected Attributes
	$moduleLoader
	$backPath
	$linkModules
	$loadedModules

---

Detailed Description

Definition at line 40 of file class.modulemenu.php.

---

Constructor & Destructor Documentation

ModuleMenu::__construct

(

)

constructor, initializes several variables

Returns:

void

Definition at line 59 of file class.modulemenu.php.

References $GLOBALS, and t3lib_div\makeInstance().

---

Member Function Documentation

ModuleMenu::appendQuestionmarkToLink

(

$

link

)

[protected]

Appends a '?' if there is none in the string already

Parameters:

string

Link URL

Returns:

string link URl appended with ? if there wasn't one

Definition at line 328 of file class.modulemenu.php.

ModuleMenu::getCollapsedStates

(

)

[protected]

loads the collapse states for the main modules from user's configuration (uc)

Returns:

array collapse states

Definition at line 91 of file class.modulemenu.php.

References $GLOBALS.

ModuleMenu::getLoadedModules

(

)

returns the loaded modules

Returns:

array array of loaded modules

Definition at line 159 of file class.modulemenu.php.

ModuleMenu::getModuleData	(	$	params,
		$	ajaxObj
	)

ModuleMenu Store loading data

Parameters:

array_type	$params
object	$ajaxObj

Definition at line 107 of file class.modulemenu.php.

References $GLOBALS, and getRawModuleData().

ModuleMenu::getModuleIcon

(

$

moduleKey

)

[protected]

gets the module icon and its size

Parameters:

string

module key

Returns:

array icon data array with 'filename', 'size', and 'html'

Definition at line 264 of file class.modulemenu.php.

ModuleMenu::getModuleIconAbsolute

(

$

iconFilename

)

[protected]

Returns the filename readable for the script from PATH_typo3. That means absolute names are just returned while relative names are prepended with the path pointing back to typo3/ dir

Parameters:

string

icon filename

Returns:

string icon filename with absolute path

See also:

getModuleIconRelative()

Definition at line 297 of file class.modulemenu.php.

ModuleMenu::getModuleIconRelative

(

$

iconFilename

)

[protected]

Returns relative path to the icon filename for use in img-tags

Parameters:

string

icon filename

Returns:

string icon filename with relative path

See also:

getModuleIconAbsolute()

Definition at line 313 of file class.modulemenu.php.

ModuleMenu::getRawModuleData

(

)

gets the raw module data

Returns:

array multi dimension array with module data

Definition at line 184 of file class.modulemenu.php.

Referenced by getModuleData().

ModuleMenu::renderLogoutButton

(

)

renders the logout button form

Returns:

string html code snippet displaying the logout button

Definition at line 341 of file class.modulemenu.php.

ModuleMenu::saveMenuState	(	$	params,
		$	ajaxObj
	)

saves the menu's toggle state in the backend user's uc

Parameters:

array	array of parameters from the AJAX interface, currently unused
TYPO3AJAX	object of type TYPO3AJAX

Returns:

void

Definition at line 170 of file class.modulemenu.php.

ModuleMenu::setBackPath

(

$

backPath

)

sets the path back to /typo3/

Parameters:

string

path back to /typo3/

Returns:

void

Definition at line 78 of file class.modulemenu.php.

References $backPath.

ModuleMenu::setLinkModules

(

$

linkModules

)

turns linking of modules on or off

Parameters:

boolean

status for linking modules with a-tags, set to false to turn lining off

Definition at line 357 of file class.modulemenu.php.

---

Member Data Documentation

ModuleMenu::$backPath [protected]

Definition at line 49 of file class.modulemenu.php.

Referenced by setBackPath().

ModuleMenu::$linkModules [protected]

Definition at line 50 of file class.modulemenu.php.

ModuleMenu::$loadedModules [protected]

Definition at line 51 of file class.modulemenu.php.

ModuleMenu::$moduleLoader [protected]

Definition at line 47 of file class.modulemenu.php.

---

The documentation for this class was generated from the following file:

• typo3/classes/class.modulemenu.php