TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository:

Public Member Functions
	__construct ()
SplObjectStorage	loadAllowedModules (array $excludeGroupNames=[])
SplObjectStorage false	findByGroupName ($groupName='')
TYPO3 CMS Backend Domain Model Module BackendModule bool	findByModuleName ($name)
TYPO3 CMS Backend Domain Model Module BackendModule bool	findByModuleNameInGivenEntries ($name, \SplObjectStorage $entries)
array	getRawModuleMenuData ()
	modulesHaveNavigationComponent ()

Protected Member Functions
	convertRawModuleDataToModuleMenuObject (array $rawModuleData)
TYPO3 CMS Backend Domain Model Module BackendModule	createEntryFromRawData (array $module)
	createMenuEntriesForTbeModulesExt ()
array	removeHiddenModules ($loadedModules)
string	getModuleIcon ($moduleKey, $moduleData)
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()

Protected Attributes
TYPO3 CMS Backend Module ModuleStorage	$moduleStorage

Detailed Description

Repository for backend module menu compiles all data from $GLOBALS[TBE_MODULES]

Definition at line 33 of file BackendModuleRepository.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::__construct

(

)

Constructs the module menu and gets the Singleton instance of the menu

Definition at line 42 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\convertRawModuleDataToModuleMenuObject(), TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createMenuEntriesForTbeModulesExt(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getRawModuleMenuData().

Member Function Documentation

convertRawModuleDataToModuleMenuObject()

TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::convertRawModuleDataToModuleMenuObject ( array  $rawModuleData )

protected

Creates the module menu object structure from the raw data array

Parameters

array

$rawModuleData

Definition at line 133 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createEntryFromRawData().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\__construct().

createEntryFromRawData()

TYPO3 CMS Backend Domain Model Module BackendModule TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::createEntryFromRawData ( array  $module )

protected

Creates a menu entry object from an array

Parameters

array

$module

Returns

‪\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule

Definition at line 153 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getBackendUser(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getLanguageService().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\convertRawModuleDataToModuleMenuObject(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createMenuEntriesForTbeModulesExt().

createMenuEntriesForTbeModulesExt()

TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::createMenuEntriesForTbeModulesExt ( )

protected

Creates the "third level" menu entries (submodules for the info module for example) from the TBE_MODULES_EXT array

Definition at line 200 of file BackendModuleRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createEntryFromRawData(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\findByModuleName().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\__construct().

findByGroupName()

SplObjectStorage false TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::findByGroupName

(

$groupName = ''

)

Parameters

string

$groupName

Returns

‪\SplObjectStorage|false

Definition at line 80 of file BackendModuleRepository.php.

findByModuleName()

TYPO3 CMS Backend Domain Model Module BackendModule bool TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::findByModuleName

(

$name

)

Finds a module menu entry by name

Parameters

string

$name

Returns

‪\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule|bool

Definition at line 97 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\findByModuleNameInGivenEntries().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createMenuEntriesForTbeModulesExt().

findByModuleNameInGivenEntries()

TYPO3 CMS Backend Domain Model Module BackendModule bool TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::findByModuleNameInGivenEntries	(		$name,
		\SplObjectStorage	$entries
	)

Finds a module menu entry by name in a given storage

Parameters

string	$name
\SplObjectStorage	$entries

Returns

‪\TYPO3\CMS\Backend\Domain\Model\Module\BackendModule|bool

Definition at line 111 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Model\Module\BackendModule\getChildren().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\findByModuleName().

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 388 of file BackendModuleRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createEntryFromRawData(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\removeHiddenModules().

getLanguageService()

LanguageService TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::getLanguageService ( )

protected

Return language service instance

Returns

‪LanguageService

Definition at line 380 of file BackendModuleRepository.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\createEntryFromRawData().

getModuleIcon()

string TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::getModuleIcon (   $moduleKey,   $moduleData  )

protected

gets the module icon

Parameters

string	$moduleKey	‪Module key
array	$moduleData	‪the compiled data associated with it

Returns

‪string Icon data, either sprite or tag

Definition at line 362 of file BackendModuleRepository.php.

References $iconRegistry.

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getRawModuleMenuData().

getRawModuleMenuData()

array TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::getRawModuleMenuData

(

)

loads the module menu from the moduleloader based on $GLOBALS['TBE_MODULES'] and compiles an array with all the data needed for menu etc.

Returns

‪array

Definition at line 231 of file BackendModuleRepository.php.

References $GLOBALS, TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getModuleIcon(), and TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\removeHiddenModules().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\__construct().

loadAllowedModules()

SplObjectStorage TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::loadAllowedModules

(

array

$excludeGroupNames = []

)

loads all module information in the module storage

Parameters

array

$excludeGroupNames

Returns

‪\SplObjectStorage

Definition at line 58 of file BackendModuleRepository.php.

modulesHaveNavigationComponent()

TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::modulesHaveNavigationComponent

(

)

Definition at line 312 of file BackendModuleRepository.php.

removeHiddenModules()

array TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::removeHiddenModules (   $loadedModules )

protected

Reads User configuration from options.hideModules and removes modules accordingly.

Parameters

array

$loadedModules

Returns

‪array

Definition at line 331 of file BackendModuleRepository.php.

References TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getBackendUser(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\getTSConfig(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getRawModuleMenuData().

Member Data Documentation

$moduleStorage

TYPO3 CMS Backend Module ModuleStorage TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository::$moduleStorage

protected

Definition at line 37 of file BackendModuleRepository.php.