ModuleMenu Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	__construct ()
	setBackPath ($backPath)
	getLoadedModules ()
	saveMenuState ($params, &$ajaxObj)
	render ($wrapInUl=true)
	renderAjax ($params=array(), TYPO3AJAX &$ajaxObj=null)
	renderSubModules ($modules, $menuState=false)
	getRawModuleData ()
	getGotoModuleJavascript ()
	renderLogoutButton ()
	setLinkModules ($linkModules)
	getFsMod ()
Geschützte Methoden
	getCollapsedStates ()
	getModuleIcon ($moduleKey)
	getModuleIconAbsolute ($iconFilename)
	getModuleIconRelative ($iconFilename)
	getNavigationFramePrefix ($moduleData, $subModuleData=array())
	appendQuestionmarkToLink ($link)
Geschützte Attribute
	$moduleLoader
	$backPath
	$linkModules
	$loadedModules
	$fsMod

---

Beschreibung der Konstruktoren und Destruktoren

ModuleMenu::__construct

(

)

constructor, initializes several variables

Rückgabe:

void

---

Dokumentation der Elementfunktionen

ModuleMenu::appendQuestionmarkToLink

(

$

link

)

[protected]

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

Parameter:

string

Link URL

Rückgabe:

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

ModuleMenu::getCollapsedStates

(

)

[protected]

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

Rückgabe:

array collapse states

ModuleMenu::getFsMod

(

)

gets the frameset (leftover) helper

Rückgabe:

array array of javascript snippets

ModuleMenu::getGotoModuleJavascript

(

)

generates javascript code to switch between modules

Rückgabe:

string javascript code snippet to switch modules

ModuleMenu::getLoadedModules

(

)

returns the loaded modules

Rückgabe:

array array of loaded modules

ModuleMenu::getModuleIcon

(

$

moduleKey

)

[protected]

gets the module icon and its size

Parameter:

string

module key

Rückgabe:

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

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

Parameter:

string

icon filename

Rückgabe:

string icon filename with absolute path

Siehe auch:

getModuleIconRelative()

ModuleMenu::getModuleIconRelative

(

$

iconFilename

)

[protected]

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

Parameter:

string

icon filename

Rückgabe:

string icon filename with relative path

Siehe auch:

getModuleIconAbsolute()

ModuleMenu::getNavigationFramePrefix	(	$	moduleData,
		$	subModuleData = array()
	)			[protected]

Returns a prefix used to call the navigation frame with parameters which then will call the scripts defined in the modules info array.

Parameter:

	array	module data array
	array	submodule data array

Rückgabe:

string result URL string

ModuleMenu::getRawModuleData

(

)

gets the raw module data

Rückgabe:

array multi dimension array with module data

ModuleMenu::render

(

$

wrapInUl = true

)

renders the backend menu as unordered list

Parameter:

boolean

optional parameter used to switch wrapping the menu in ul tags off for AJAX calls

Rückgabe:

string menu html code to use in the backend

ModuleMenu::renderAjax	(	$	params = array(),
		TYPO3AJAX &$	ajaxObj = null
	)

renders the backend menu as unordered list as an AJAX response without the wrapping ul tags

Parameter:

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

Rückgabe:

void

ModuleMenu::renderLogoutButton

(

)

renders the logout button form

Rückgabe:

string html code snippet displaying the logout button

ModuleMenu::renderSubModules	(	$	modules,
		$	menuState = false
	)

renders submodules

Parameter:

	array	array of (sub)module data
	boolean	collapse state of menu item, defaults to false

Rückgabe:

string (sub)module html code

ModuleMenu::saveMenuState	(	$	params,
		&$	ajaxObj
	)

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

Parameter:

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

Rückgabe:

void

ModuleMenu::setBackPath

(

$

backPath

)

sets the path back to /typo3/

Parameter:

string

path back to /typo3/

Rückgabe:

void

ModuleMenu::setLinkModules

(

$

linkModules

)

turns linking of modules on or off

Parameter:

boolean

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

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/typo3/classes/class.modulemenu.php