ServiceProvider extends AbstractServiceProvider

Internal

Table of Contents

Methods

addEventListeners()  : ListenerProvider
configureBackendModules()  : ArrayObject
configureBackendRoutes()  : ArrayObject
configureContentSecurityPolicies()  : Map<Scope, Map<MutationOrigin, MutationCollection>>
configureDashboardPresetRegistry()  : DashboardPresetRegistry
configureDashboardPresets()  : ArrayObject
configureGlobalPageTsConfig()  : ArrayObject
configureIcons()  : ArrayObject
configureMiddlewares()  : ArrayObject
configureWidgetGroupRegistry()  : WidgetGroupRegistry
configureWidgetGroups()  : ArrayObject
configureWidgets()  : ArrayObject
getConfigurationWarmer()  : Closure
getDashboardPresets()  : ArrayObject
getExtensions()  : array<string|int, callable>
Returns a list of all container entries extended by this service provider.
getFactories()  : array<string|int, callable>
Returns a list of all container entries registered by this service provider.
getWidgetGroups()  : ArrayObject
getWidgets()  : ArrayObject
getPackageName()  : string
Return the composer package name. This is the 'name' attribute in composer.json.
getPackagePath()  : string
Return the path to the package location, including trailing slash should return the value of: __DIR__ . '/../' for ServiceProviders located in the Classes/ directory
getPathsOfInstalledPackages()  : array<string|int, mixed>
new()  : mixed
Create an instance of a class. Supports auto injection of the logger.
requireFile()  : mixed
Require a file in a safe scoped environment avoiding local variable clashes.

Methods

configureBackendModules()

public static configureBackendModules(ContainerInterface $container, ArrayObject $modules[, string|null $path = null ][, string|null $packageName = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$modules : ArrayObject
$path : string|null = null

supplied when invoked internally through PseudoServiceProvider

$packageName : string|null = null

supplied when invoked internally through PseudoServiceProvider

Return values
ArrayObject

configureBackendRoutes()

public static configureBackendRoutes(ContainerInterface $container, ArrayObject $routes[, string|null $path = null ][, string|null $packageName = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$routes : ArrayObject
$path : string|null = null

supplied when invoked internally through PseudoServiceProvider

$packageName : string|null = null

supplied when invoked internally through PseudoServiceProvider

Return values
ArrayObject

configureContentSecurityPolicies()

public static configureContentSecurityPolicies(ContainerInterface $container, Map<Scope, Map<MutationOrigin, MutationCollection>> $mutations[, string|null $path = null ][, string|null $packageName = null ]) : Map<Scope, Map<MutationOrigin, MutationCollection>>
Parameters
$container : ContainerInterface
$mutations : Map<Scope, Map<MutationOrigin, MutationCollection>>
$path : string|null = null
$packageName : string|null = null
Return values
Map<Scope, Map<MutationOrigin, MutationCollection>>

configureDashboardPresets()

public static configureDashboardPresets(ContainerInterface $container, ArrayObject $presets) : ArrayObject
Parameters
$container : ContainerInterface
$presets : ArrayObject
Return values
ArrayObject

configureGlobalPageTsConfig()

public static configureGlobalPageTsConfig(ContainerInterface $container, ArrayObject $tsConfigFiles[, string|null $path = null ]) : ArrayObject
Deprecated

since v12, will be removed with v13 together with class PageTsConfigLoader.

Parameters
$container : ContainerInterface
$tsConfigFiles : ArrayObject
$path : string|null = null
Return values
ArrayObject

configureIcons()

public static configureIcons(ContainerInterface $container, ArrayObject $icons[, string|null $path = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$icons : ArrayObject
$path : string|null = null
Return values
ArrayObject

configureMiddlewares()

public static configureMiddlewares(ContainerInterface $container, ArrayObject $middlewares[, string|null $path = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$middlewares : ArrayObject
$path : string|null = null

supplied when invoked internally through PseudoServiceProvider

Return values
ArrayObject

configureWidgetGroups()

public static configureWidgetGroups(ContainerInterface $container, ArrayObject $widgetGroups[, string|null $path = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$widgetGroups : ArrayObject
$path : string|null = null

supplied when invoked internally through PseudoServiceProvider

Return values
ArrayObject

configureWidgets()

public static configureWidgets(ContainerInterface $container, ArrayObject $widgets[, string|null $path = null ]) : ArrayObject
Parameters
$container : ContainerInterface
$widgets : ArrayObject
$path : string|null = null

supplied when invoked internally through PseudoServiceProvider

Return values
ArrayObject

getConfigurationWarmer()

public static getConfigurationWarmer(ContainerInterface $container) : Closure
Parameters
$container : ContainerInterface
Return values
Closure

getDashboardPresets()

public static getDashboardPresets(ContainerInterface $container) : ArrayObject
Parameters
$container : ContainerInterface
Return values
ArrayObject

getExtensions()

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

public getExtensions() : array<string|int, callable>
  • 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.
Return values
array<string|int, callable>

getFactories()

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

public getFactories() : array<string|int, callable>
  • 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)

Return values
array<string|int, callable>

getWidgetGroups()

public static getWidgetGroups(ContainerInterface $container) : ArrayObject
Parameters
$container : ContainerInterface
Return values
ArrayObject

getWidgets()

public static getWidgets(ContainerInterface $container) : ArrayObject
Parameters
$container : ContainerInterface
Return values
ArrayObject

getPackageName()

Return the composer package name. This is the 'name' attribute in composer.json.

protected static getPackageName() : string

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

Return values
string

getPackagePath()

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

protected static getPackagePath() : string
Return values
string

getPathsOfInstalledPackages()

protected static getPathsOfInstalledPackages() : array<string|int, mixed>
Return values
array<string|int, mixed>

new()

Create an instance of a class. Supports auto injection of the logger.

protected static new(ContainerInterface $container, string $className[, array<string|int, mixed> $constructorArguments = [] ]) : mixed
Parameters
$container : ContainerInterface
$className : string

name of the class to instantiate, must not be empty and not start with a backslash

$constructorArguments : array<string|int, mixed> = []

Arguments for the constructor

requireFile()

Require a file in a safe scoped environment avoiding local variable clashes.

protected static requireFile(string $filename) : mixed
Parameters
$filename : string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results