‪TYPO3CMS  ‪main
TYPO3\CMS\Dashboard\ServiceProvider Class Reference
Inheritance diagram for TYPO3\CMS\Dashboard\ServiceProvider:
TYPO3\CMS\Core\Package\AbstractServiceProvider TYPO3\CMS\Core\DependencyInjection\ServiceProviderInterface

Public Member Functions

 getFactories ()
 
 getExtensions ()
 

Static Public Member Functions

static getDashboardPresets (ContainerInterface $container)
 
static getWidgetGroups (ContainerInterface $container)
 
static getWidgets (ContainerInterface $container)
 
static configureDashboardPresetRegistry (ContainerInterface $container, DashboardPresetRegistry $dashboardPresetRegistry=null)
 
static configureWidgetGroupRegistry (ContainerInterface $container, WidgetGroupRegistry $widgetGroupRegistry=null)
 
static configureDashboardPresets (ContainerInterface $container, \ArrayObject $presets)
 
static configureWidgetGroups (ContainerInterface $container, \ArrayObject $widgetGroups, string $path=null)
 
static configureWidgets (ContainerInterface $container, \ArrayObject $widgets, string $path=null)
 
static getConfigurationWarmer (ContainerInterface $container)
 
static addEventListeners (ContainerInterface $container, ListenerProvider $listenerProvider)
 
- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Core\Package\AbstractServiceProvider
static configureMiddlewares (ContainerInterface $container, \ArrayObject $middlewares, string $path=null)
 
static configureBackendRoutes (ContainerInterface $container, \ArrayObject $routes, string $path=null, string $packageName=null)
 
static configureBackendModules (ContainerInterface $container, \ArrayObject $modules, string $path=null, string $packageName=null)
 
static Map< Scope, configureContentSecurityPolicies(ContainerInterface $container, Map $mutations, string $path=null, string $packageName=null):Map { $path=$path ?? static::getPackagePath();$packageName=$packageName ?? static::getPackageName();$fileName=$path . 'Configuration/ContentSecurityPolicies.php';if(file_exists( $fileName)) { $mutationsInPackage=require $fileName;foreach( $mutationsInPackage as $scope=> $mutation) { if(!isset( $mutations[ $scope])) { $mutations[ $scope]=new Map();} $origin=new MutationOrigin(MutationOriginType::package, $packageName);$mutations[ $scope][ $origin]=$mutation;} } return $mutations;} public static function configureIcons(ContainerInterface $container, \ArrayObject $icons, string $path=null):\ArrayObject { $path=$path ?? static::getPackagePath();$iconsFileNameForPackage=$path . 'Configuration/Icons.php';if(file_exists( $iconsFileNameForPackage)) { $definedIconsInPackage=require $iconsFileNameForPackage;if(is_array( $definedIconsInPackage)) { $icons-> exchangeArray (array_merge($icons->getArrayCopy(), $definedIconsInPackage))
 
static configureSetCollector (ContainerInterface $container, SetCollector $setCollector, string $path=null)
 

Static Protected Member Functions

static getPackagePath ()
 
static getPackageName ()
 
static getPathsOfInstalledPackages ()
 
- ‪Static Protected Member Functions inherited from ‪TYPO3\CMS\Core\Package\AbstractServiceProvider
static mixed new (ContainerInterface $container, string $className, array $constructorArguments=[])
 

Private Attributes

const CACHE_IDENTIFIER_PREFIX = 'Dashboard_'
 

Additional Inherited Members

- ‪Public Attributes inherited from ‪TYPO3\CMS\Core\Package\AbstractServiceProvider
return $icons
 

Detailed Description

Definition at line 31 of file ServiceProvider.php.

Member Function Documentation

◆ addEventListeners()

static TYPO3\CMS\Dashboard\ServiceProvider::addEventListeners ( ContainerInterface  $container,
ListenerProvider  $listenerProvider 
)
static

◆ configureDashboardPresetRegistry()

static TYPO3\CMS\Dashboard\ServiceProvider::configureDashboardPresetRegistry ( ContainerInterface  $container,
DashboardPresetRegistry  $dashboardPresetRegistry = null 
)
static

◆ configureDashboardPresets()

static TYPO3\CMS\Dashboard\ServiceProvider::configureDashboardPresets ( ContainerInterface  $container,
\ArrayObject  $presets 
)
static

◆ configureWidgetGroupRegistry()

static TYPO3\CMS\Dashboard\ServiceProvider::configureWidgetGroupRegistry ( ContainerInterface  $container,
WidgetGroupRegistry  $widgetGroupRegistry = null 
)
static

◆ configureWidgetGroups()

static TYPO3\CMS\Dashboard\ServiceProvider::configureWidgetGroups ( ContainerInterface  $container,
\ArrayObject  $widgetGroups,
string  $path = null 
)
static
Parameters
string$path‪supplied when invoked internally through PseudoServiceProvider

Definition at line 154 of file ServiceProvider.php.

References TYPO3\CMS\Dashboard\ServiceProvider\getPathsOfInstalledPackages().

Referenced by TYPO3\CMS\Dashboard\ServiceProvider\getExtensions().

◆ configureWidgets()

static TYPO3\CMS\Dashboard\ServiceProvider::configureWidgets ( ContainerInterface  $container,
\ArrayObject  $widgets,
string  $path = null 
)
static
Parameters
string$path‪supplied when invoked internally through PseudoServiceProvider

Definition at line 173 of file ServiceProvider.php.

References TYPO3\CMS\Dashboard\ServiceProvider\getPathsOfInstalledPackages().

Referenced by TYPO3\CMS\Dashboard\ServiceProvider\getExtensions().

◆ getConfigurationWarmer()

static TYPO3\CMS\Dashboard\ServiceProvider::getConfigurationWarmer ( ContainerInterface  $container)
static

◆ getDashboardPresets()

static TYPO3\CMS\Dashboard\ServiceProvider::getDashboardPresets ( ContainerInterface  $container)
static

◆ getExtensions()

TYPO3\CMS\Dashboard\ServiceProvider::getExtensions ( )

Returns a list of all container entries extended by this service provider.

  • ‪the key is the entry name
  • ‪the value is a callable that will return the modified entry

Callables have the following signature: function(Psr\Container\ContainerInterface $container, $previous) or function(Psr\Container\ContainerInterface $container, $previous = null)

About factories parameters:

  • ‪the container (instance of Psr\Container\ContainerInterface)
  • ‪the entry to be extended. If the entry to be extended does not exist and the parameter is nullable, null will be passed.
Returns
‪callable[]

Reimplemented from TYPO3\CMS\Core\Package\AbstractServiceProvider.

Definition at line 55 of file ServiceProvider.php.

References TYPO3\CMS\Dashboard\ServiceProvider\addEventListeners(), TYPO3\CMS\Dashboard\ServiceProvider\configureDashboardPresetRegistry(), TYPO3\CMS\Dashboard\ServiceProvider\configureDashboardPresets(), TYPO3\CMS\Dashboard\ServiceProvider\configureWidgetGroupRegistry(), TYPO3\CMS\Dashboard\ServiceProvider\configureWidgetGroups(), and TYPO3\CMS\Dashboard\ServiceProvider\configureWidgets().

◆ getFactories()

TYPO3\CMS\Dashboard\ServiceProvider::getFactories ( )

Returns a list of all container entries registered by this service provider.

  • ‪the key is the entry name
  • ‪the value is a callable that will return the entry, aka the factory

Factories have the following signature: function(\Psr\Container\ContainerInterface $container)

Returns
‪callable[]

Reimplemented from TYPO3\CMS\Core\Package\AbstractServiceProvider.

Definition at line 45 of file ServiceProvider.php.

References TYPO3\CMS\Dashboard\ServiceProvider\getConfigurationWarmer(), TYPO3\CMS\Dashboard\ServiceProvider\getDashboardPresets(), TYPO3\CMS\Dashboard\ServiceProvider\getWidgetGroups(), and TYPO3\CMS\Dashboard\ServiceProvider\getWidgets().

◆ getPackageName()

static TYPO3\CMS\Dashboard\ServiceProvider::getPackageName ( )
staticprotected

Return the composer package name. This is the 'name' attribute in composer.json. Note composer.json existence for 'extensions' is still not mandatory in non-composer mode, the method returns empty string in this case.

Reimplemented from TYPO3\CMS\Core\Package\AbstractServiceProvider.

Definition at line 40 of file ServiceProvider.php.

◆ getPackagePath()

static TYPO3\CMS\Dashboard\ServiceProvider::getPackagePath ( )
staticprotected

Return the path to the package location, including trailing slash should return the value of: DIR . '/../' for ServiceProviders located in the Classes/ directory

Reimplemented from TYPO3\CMS\Core\Package\AbstractServiceProvider.

Definition at line 35 of file ServiceProvider.php.

◆ getPathsOfInstalledPackages()

static TYPO3\CMS\Dashboard\ServiceProvider::getPathsOfInstalledPackages ( )
staticprotected

◆ getWidgetGroups()

static TYPO3\CMS\Dashboard\ServiceProvider::getWidgetGroups ( ContainerInterface  $container)
static

◆ getWidgets()

static TYPO3\CMS\Dashboard\ServiceProvider::getWidgets ( ContainerInterface  $container)
static

Member Data Documentation

◆ CACHE_IDENTIFIER_PREFIX

const TYPO3\CMS\Dashboard\ServiceProvider::CACHE_IDENTIFIER_PREFIX = 'Dashboard_'
private

Definition at line 33 of file ServiceProvider.php.