TYPO3\CMS\Dashboard\DashboardInitializationService Class Reference

Public Member Functions
	__construct (private readonly DashboardRepository $dashboardRepository, private readonly DashboardPresetRegistry $dashboardPresetRegistry)
	initializeDashboards (ServerRequestInterface $request, BackendUserAuthentication $user)
	getCurrentDashboard ()
Dashboard[]	getDashboardsForUser ()
list< JavaScriptModuleInstruction >	getJavaScriptModuleInstructions ()
	getJsFiles ()
	getCssFiles ()

Protected Member Functions
	defineCurrentDashboard ()
	createDefaultDashboards ()
	defineResourcesOfWidgets (array $widgets)
	defineJavaScriptInstructions (JavaScriptInterface $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/'
array	$javaScriptModuleInstructions = []

Private Attributes
Dashboard	$currentDashboard
BackendUserAuthentication	$user
array	$jsFiles = []
array	$cssFiles = []

Detailed Description

Definition at line 33 of file DashboardInitializationService.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 48 of file DashboardInitializationService.php.

Member Function Documentation

createDefaultDashboards()

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

protected

Definition at line 79 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

Definition at line 167 of file DashboardInitializationService.php.

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

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

defineCurrentDashboard()

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

protected

Definition at line 66 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().

defineJavaScriptInstructions()

TYPO3\CMS\Dashboard\DashboardInitializationService::defineJavaScriptInstructions ( JavaScriptInterface  $widgetInstance )

protected

Definition at line 142 of file DashboardInitializationService.php.

References TYPO3\CMS\Dashboard\Widgets\JavaScriptInterface\getJavaScriptModuleInstructions().

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

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

Definition at line 153 of file DashboardInitializationService.php.

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

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

defineResourcesOfWidgets()

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

protected

Parameters

array<string,WidgetConfigurationInterface>

‪$widgets

Definition at line 126 of file DashboardInitializationService.php.

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

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

getCssFiles()

TYPO3\CMS\Dashboard\DashboardInitializationService::getCssFiles

(

)

Definition at line 200 of file DashboardInitializationService.php.

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

getCurrentDashboard()

TYPO3\CMS\Dashboard\DashboardInitializationService::getCurrentDashboard

(

)

Definition at line 61 of file DashboardInitializationService.php.

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

getDashboardsForUser()

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

(

)

Returns

‪Dashboard[]

Definition at line 109 of file DashboardInitializationService.php.

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

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

getJavaScriptModuleInstructions()

list<JavaScriptModuleInstruction> TYPO3\CMS\Dashboard\DashboardInitializationService::getJavaScriptModuleInstructions

(

)

Returns

‪list<JavaScriptModuleInstruction>

Definition at line 190 of file DashboardInitializationService.php.

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

getJsFiles()

TYPO3\CMS\Dashboard\DashboardInitializationService::getJsFiles

(

)

Definition at line 195 of file DashboardInitializationService.php.

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

initializeDashboards()

TYPO3\CMS\Dashboard\DashboardInitializationService::initializeDashboards	(	ServerRequestInterface	$request,
		BackendUserAuthentication	$user
	)

Definition at line 53 of file DashboardInitializationService.php.

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

loadCurrentDashboard()

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

protected

Definition at line 177 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 182 of file DashboardInitializationService.php.

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

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

Member Data Documentation

$cssFiles

array TYPO3\CMS\Dashboard\DashboardInitializationService::$cssFiles = []

private

Definition at line 46 of file DashboardInitializationService.php.

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

$currentDashboard

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

private

Definition at line 37 of file DashboardInitializationService.php.

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

$javaScriptModuleInstructions

array TYPO3\CMS\Dashboard\DashboardInitializationService::$javaScriptModuleInstructions = []

protected

Definition at line 43 of file DashboardInitializationService.php.

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

$jsFiles

array TYPO3\CMS\Dashboard\DashboardInitializationService::$jsFiles = []

private

Definition at line 45 of file DashboardInitializationService.php.

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

$user

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

private

Definition at line 38 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 35 of file DashboardInitializationService.php.