TYPO3\CMS\Dashboard\DashboardInitializationService Class Reference

Public Member Functions
	__construct (DashboardRepository $dashboardRepository, DashboardPresetRegistry $dashboardPresetRegistry)
	initializeDashboards (BackendUserAuthentication $user)
	getCurrentDashboard ()
Dashboard[]	getDashboardsForUser ()
array	getRequireJsModules ()
array	getJsFiles ()
array	getCssFiles ()

Protected Member Functions
	defineCurrentDashboard ()
	createDefaultDashboards ()
	defineResourcesOfWidgets (array $widgets)
	defineRequireJsModules (RequireJsModuleInterface $widgetInstance)
	defineJsFiles (AdditionalJavaScriptInterface $widgetInstance)
	defineCssFiles (AdditionalCssInterface $widgetInstance)
	loadCurrentDashboard (BackendUserAuthentication $user)
	saveCurrentDashboard (BackendUserAuthentication $user, string $identifier)

Protected Attributes
const	MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER = 'dashboard/current_dashboard/'

Private Attributes
DashboardRepository	$dashboardRepository
DashboardPresetRegistry	$dashboardPresetRegistry
Dashboard	$currentDashboard
BackendUserAuthentication	$user
array	$requireJsModules = array( )
	$jsFiles = array( )
	$cssFiles = array( )

Detailed Description

Definition at line 30 of file DashboardInitializationService.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Dashboard\DashboardInitializationService::__construct	(	DashboardRepository	$dashboardRepository,
		DashboardPresetRegistry	$dashboardPresetRegistry
	)

Definition at line 56 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$dashboardPresetRegistry, and TYPO3\CMS\Dashboard\DashboardInitializationService\$dashboardRepository.

Member Function Documentation

createDefaultDashboards()

TYPO3\CMS\Dashboard\DashboardInitializationService::createDefaultDashboards ( )

protected

Definition at line 90 of file DashboardInitializationService.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\getDashboardsForUser().

defineCssFiles()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineCssFiles ( AdditionalCssInterface  $widgetInstance )

protected

Define the correct path of the CSS files of a widget and add them to the list of CSS files that needs to be included

Parameters

AdditionalCssInterface

$widgetInstance

Definition at line 191 of file DashboardInitializationService.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), and TYPO3\CMS\Dashboard\Widgets\AdditionalCssInterface\getCssFiles().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineResourcesOfWidgets().

defineCurrentDashboard()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineCurrentDashboard ( )

protected

Definition at line 78 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$currentDashboard, TYPO3\CMS\Dashboard\DashboardInitializationService\getDashboardsForUser(), TYPO3\CMS\Dashboard\Dashboard\getIdentifier(), TYPO3\CMS\Dashboard\DashboardInitializationService\loadCurrentDashboard(), and TYPO3\CMS\Dashboard\DashboardInitializationService\saveCurrentDashboard().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\initializeDashboards().

defineJsFiles()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineJsFiles ( AdditionalJavaScriptInterface  $widgetInstance )

protected

Define the correct path of the JS files of a widget and add them to the list of JS files that needs to be included

Parameters

AdditionalJavaScriptInterface

$widgetInstance

Definition at line 175 of file DashboardInitializationService.php.

References TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), and TYPO3\CMS\Dashboard\Widgets\AdditionalJavaScriptInterface\getJsFiles().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineResourcesOfWidgets().

defineRequireJsModules()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineRequireJsModules ( RequireJsModuleInterface  $widgetInstance )

protected

Add the RequireJS modules needed by some widgets

Parameters

RequireJsModuleInterface

$widgetInstance

Definition at line 158 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\Widgets\RequireJsModuleInterface\getRequireJsModules().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineResourcesOfWidgets().

defineResourcesOfWidgets()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineResourcesOfWidgets ( array  $widgets )

protected

Parameters

array

$widgets

Definition at line 137 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\defineCssFiles(), TYPO3\CMS\Dashboard\DashboardInitializationService\defineJsFiles(), and TYPO3\CMS\Dashboard\DashboardInitializationService\defineRequireJsModules().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\initializeDashboards().

getCssFiles()

array TYPO3\CMS\Dashboard\DashboardInitializationService::getCssFiles

(

)

Returns

‪array

Definition at line 230 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$cssFiles.

getCurrentDashboard()

TYPO3\CMS\Dashboard\DashboardInitializationService::getCurrentDashboard

(

)

Definition at line 73 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$currentDashboard.

getDashboardsForUser()

Dashboard [] TYPO3\CMS\Dashboard\DashboardInitializationService::getDashboardsForUser

(

)

Returns

‪Dashboard[]

Definition at line 120 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\createDefaultDashboards().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineCurrentDashboard().

getJsFiles()

array TYPO3\CMS\Dashboard\DashboardInitializationService::getJsFiles

(

)

Returns

‪array

Definition at line 222 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$jsFiles.

getRequireJsModules()

array TYPO3\CMS\Dashboard\DashboardInitializationService::getRequireJsModules

(

)

Returns

‪array

Definition at line 214 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$requireJsModules.

initializeDashboards()

TYPO3\CMS\Dashboard\DashboardInitializationService::initializeDashboards

(

BackendUserAuthentication

$user

)

Definition at line 64 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$user, TYPO3\CMS\Dashboard\DashboardInitializationService\defineCurrentDashboard(), and TYPO3\CMS\Dashboard\DashboardInitializationService\defineResourcesOfWidgets().

Referenced by TYPO3\CMS\Dashboard\Controller\DashboardController\__construct().

loadCurrentDashboard()

TYPO3\CMS\Dashboard\DashboardInitializationService::loadCurrentDashboard ( BackendUserAuthentication  $user )

protected

Definition at line 201 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$user, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineCurrentDashboard().

saveCurrentDashboard()

TYPO3\CMS\Dashboard\DashboardInitializationService::saveCurrentDashboard ( BackendUserAuthentication  $user, string  $identifier  )

protected

Definition at line 206 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\DashboardInitializationService\$user, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\pushModuleData().

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineCurrentDashboard().

Member Data Documentation

$cssFiles

TYPO3\CMS\Dashboard\DashboardInitializationService::$cssFiles = array( )

private

Definition at line 54 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\getCssFiles().

$currentDashboard

Dashboard TYPO3\CMS\Dashboard\DashboardInitializationService::$currentDashboard

private

Definition at line 44 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\defineCurrentDashboard(), and TYPO3\CMS\Dashboard\DashboardInitializationService\getCurrentDashboard().

$dashboardPresetRegistry

DashboardPresetRegistry TYPO3\CMS\Dashboard\DashboardInitializationService::$dashboardPresetRegistry

private

Definition at line 40 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\__construct().

$dashboardRepository

DashboardRepository TYPO3\CMS\Dashboard\DashboardInitializationService::$dashboardRepository

private

Definition at line 36 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\__construct().

$jsFiles

TYPO3\CMS\Dashboard\DashboardInitializationService::$jsFiles = array( )

private

Definition at line 53 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\getJsFiles().

$requireJsModules

array TYPO3\CMS\Dashboard\DashboardInitializationService::$requireJsModules = array( )

private

Definition at line 52 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\getRequireJsModules().

$user

BackendUserAuthentication TYPO3\CMS\Dashboard\DashboardInitializationService::$user

private

Definition at line 48 of file DashboardInitializationService.php.

Referenced by TYPO3\CMS\Dashboard\DashboardInitializationService\initializeDashboards(), TYPO3\CMS\Dashboard\DashboardInitializationService\loadCurrentDashboard(), and TYPO3\CMS\Dashboard\DashboardInitializationService\saveCurrentDashboard().

MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER

const TYPO3\CMS\Dashboard\DashboardInitializationService::MODULE_DATA_CURRENT_DASHBOARD_IDENTIFIER = 'dashboard/current_dashboard/'

protected

Definition at line 32 of file DashboardInitializationService.php.