TYPO3\CMS\Backend\View\ModuleMenuView Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\ModuleMenuView:

Public Member Functions
	__construct ()
	setBackPath ($backPath)
	getModuleData ($params, $ajaxObj)
	getLoadedModules ()
	saveMenuState ($params, $ajaxObj)
	getRawModuleData ()
	renderLogoutButton ()
	setLinkModules ($linkModules)

Protected Member Functions
	getCollapsedStates ()
	unsetHiddenModules ()
	getModuleIcon ($moduleKey)
	getModuleIconAbsolute ($iconFilename)
	getModuleIconRelative ($iconFilename)
	appendQuestionmarkToLink ($link)

Protected Attributes
	$moduleLoader
	$backPath
	$linkModules
	$loadedModules

Detailed Description

class to render the TYPO3 backend menu for the modules

Author

Ingo Renner ingo@.nosp@m.typo.nosp@m.3.org

Definition at line 25 of file ModuleMenuView.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\ModuleMenuView::__construct

(

)

Constructor, initializes several variables

Definition at line 43 of file ModuleMenuView.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

appendQuestionmarkToLink()

TYPO3\CMS\Backend\View\ModuleMenuView::appendQuestionmarkToLink (   $link )

protected

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

Parameters

string

$link

Link URL

Returns

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

Definition at line 334 of file ModuleMenuView.php.

getCollapsedStates()

TYPO3\CMS\Backend\View\ModuleMenuView::getCollapsedStates ( )

protected

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

Returns

array Collapse states

Definition at line 75 of file ModuleMenuView.php.

References $GLOBALS.

getLoadedModules()

TYPO3\CMS\Backend\View\ModuleMenuView::getLoadedModules

(

)

Returns the loaded modules

Returns

array Array of loaded modules

Definition at line 138 of file ModuleMenuView.php.

getModuleData()

TYPO3\CMS\Backend\View\ModuleMenuView::getModuleData	(		$params,
			$ajaxObj
	)

ModuleMenu Store loading data

Parameters

array	$params
\TYPO3\CMS\Core\Http\AjaxRequestHandler	$ajaxObj

Returns

array

Definition at line 90 of file ModuleMenuView.php.

References $GLOBALS, and TYPO3\CMS\Backend\View\ModuleMenuView\getRawModuleData().

getModuleIcon()

TYPO3\CMS\Backend\View\ModuleMenuView::getModuleIcon (   $moduleKey )

protected

gets the module icon and its size

Parameters

string

$moduleKey

Module key

Returns

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

Definition at line 274 of file ModuleMenuView.php.

getModuleIconAbsolute()

TYPO3\CMS\Backend\View\ModuleMenuView::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

$iconFilename

Icon filename

Returns

string Icon filename with absolute path

See also

getModuleIconRelative()

Definition at line 307 of file ModuleMenuView.php.

getModuleIconRelative()

TYPO3\CMS\Backend\View\ModuleMenuView::getModuleIconRelative (   $iconFilename )

protected

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

Parameters

string

$iconFilename

Icon filename

Returns

string Icon filename with relative path

See also

getModuleIconAbsolute()

Definition at line 321 of file ModuleMenuView.php.

getRawModuleData()

TYPO3\CMS\Backend\View\ModuleMenuView::getRawModuleData

(

)

gets the raw module data

Returns

array Multi dimension array with module data

Definition at line 188 of file ModuleMenuView.php.

Referenced by TYPO3\CMS\Backend\View\ModuleMenuView\getModuleData().

renderLogoutButton()

TYPO3\CMS\Backend\View\ModuleMenuView::renderLogoutButton

(

)

renders the logout button form

Returns

string Html code snippet displaying the logout button

Definition at line 346 of file ModuleMenuView.php.

saveMenuState()

TYPO3\CMS\Backend\View\ModuleMenuView::saveMenuState	(		$params,
			$ajaxObj
	)

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

Parameters

array	$params	Array of parameters from the AJAX interface, currently unused
\TYPO3\CMS\Core\Http\AjaxRequestHandler	$ajaxObj	Object of type AjaxRequestHandler

Returns

void

Definition at line 149 of file ModuleMenuView.php.

setBackPath()

TYPO3\CMS\Backend\View\ModuleMenuView::setBackPath

(

$backPath

)

sets the path back to /typo3/

Parameters

string

$backPath

Path back to /typo3/

Exceptions

Definition at line 63 of file ModuleMenuView.php.

References TYPO3\CMS\Backend\View\ModuleMenuView\$backPath.

setLinkModules()

TYPO3\CMS\Backend\View\ModuleMenuView::setLinkModules

(

$linkModules

)

turns linking of modules on or off

Parameters

boolean

$linkModules

Status for linking modules with a-tags, set to FALSE to turn lining off

Exceptions

Definition at line 362 of file ModuleMenuView.php.

unsetHiddenModules()

TYPO3\CMS\Backend\View\ModuleMenuView::unsetHiddenModules ( )

protected

Reads User configuration from options.hideModules and removes modules from $this->loadedModules accordingly.

Returns

void

Definition at line 162 of file ModuleMenuView.php.

Member Data Documentation

$backPath

TYPO3\CMS\Backend\View\ModuleMenuView::$backPath

protected

Definition at line 34 of file ModuleMenuView.php.

Referenced by TYPO3\CMS\Backend\View\ModuleMenuView\setBackPath().

$linkModules

TYPO3\CMS\Backend\View\ModuleMenuView::$linkModules

protected

Definition at line 36 of file ModuleMenuView.php.

$loadedModules

TYPO3\CMS\Backend\View\ModuleMenuView::$loadedModules

protected

Definition at line 38 of file ModuleMenuView.php.

$moduleLoader

TYPO3\CMS\Backend\View\ModuleMenuView::$moduleLoader

protected

Definition at line 32 of file ModuleMenuView.php.