ServiceProvider extends AbstractServiceProvider

Internal

Table of Contents

Methods

configureBackendModules()  : ArrayObject
configureBackendRoutes()  : ArrayObject
configureCommands()  : CommandRegistry
configureContentSecurityPolicies()  : Map<Scope, Map<MutationOrigin, MutationCollection>>
configureGlobalPageTsConfig()  : ArrayObject
configureIconRegistry()  : IconRegistry
configureIcons()  : ArrayObject
configureMiddlewares()  : ArrayObject
configurePageTsConfigLoader()  : PageTsConfigLoader
extendEventListenerProvider()  : ListenerProvider
getAstTraverser()  : AstTraverser
getBackendEntryPointResolver()  : BackendEntryPointResolver
getBootService()  : BootService
getCacheFlushCommand()  : CacheFlushCommand
getCacheManager()  : CacheManager
getCacheWarmupCommand()  : CacheWarmupCommand
getCharsetConverter()  : CharsetConverter
getCommentAwareAstBuilder()  : CommentAwareAstBuilder
getConnectionPool()  : ConnectionPool
getConsoleCommandApplication()  : CommandApplication
getConsoleCommandRegistry()  : CommandRegistry
getContentSecurityPolicies()  : Map
getContext()  : Context
getDependencyOrderingService()  : DependencyOrderingService
getDriverRegistry()  : DriverRegistry
getDumpAutoloadCommand()  : DumpAutoloadCommand
getEventDispatcher()  : EventDispatcher
getEventListenerProvider()  : ListenerProvider
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.
getFailsafePackageManager()  : FailsafePackageManager
getFileIndexRepository()  : FileIndexRepository
getFlashMessageService()  : FlashMessageService
getFlexFormService()  : FlexFormService
getFormProtectionFactory()  : FormProtectionFactory
getGlobalPageTsConfig()  : ArrayObject
getGuzzleClientFactory()  : GuzzleClientFactory
getHelpCommand()  : HelpCommand
getIconFactory()  : IconFactory
getIconRegistry()  : IconRegistry
getIcons()  : ArrayObject
getLanguageServiceFactory()  : LanguageServiceFactory
getLanguageStore()  : LanguageStore
getListCommand()  : ListCommand
getLocales()  : Locales
getLocalizationFactory()  : LocalizationFactory
getLosslessTokenizer()  : LosslessTokenizer
getMailTransportFactory()  : TransportFactory
getMetaDataRepository()  : MetaDataRepository
getMiddlewares()  : ArrayObject
getMiddlewareStackResolver()  : MiddlewareStackResolver
getOpcodeCacheService()  : OpcodeCacheService
getPackageDependentCacheIdentifier()  : PackageDependentCacheIdentifier
getPasswordHashFactory()  : PasswordHashFactory
getProcessedFileRepository()  : ProcessedFileRepository
getRegistry()  : Registry
getRequestContextFactory()  : RequestContextFactory
getRequestFactory()  : RequestFactory
getResourceFactory()  : ResourceFactory
getResponsePropagationMiddleware()  : ResponsePropagation
getSiteConfiguration()  : SiteConfiguration
getStorageRepository()  : StorageRepository
getSymfonyEventDispatcher()  : EventDispatcherInterface
getTimeTracker()  : TimeTracker
getTypoScriptService()  : TypoScriptService
getTypoScriptStringFactory()  : TypoScriptStringFactory
getVerifyHostHeaderMiddleware()  : VerifyHostHeader
provideFallbackEventDispatcher()  : EventDispatcherInterface
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
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>>

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

getAstTraverser()

public static getAstTraverser(ContainerInterface $container) : AstTraverser
Parameters
$container : ContainerInterface
Return values
AstTraverser

getBootService()

public static getBootService(ContainerInterface $container) : BootService
Parameters
$container : ContainerInterface
Return values
BootService

getCacheManager()

public static getCacheManager(ContainerInterface $container) : CacheManager
Parameters
$container : ContainerInterface
Return values
CacheManager

getContentSecurityPolicies()

public static getContentSecurityPolicies(ContainerInterface $container) : Map
Parameters
$container : ContainerInterface
Return values
Map

getContext()

public static getContext(ContainerInterface $container) : Context
Parameters
$container : ContainerInterface
Return values
Context

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>

getGlobalPageTsConfig()

public static getGlobalPageTsConfig(ContainerInterface $container) : ArrayObject
Deprecated

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

Parameters
$container : ContainerInterface
Return values
ArrayObject

getHelpCommand()

public static getHelpCommand(ContainerInterface $container) : HelpCommand
Parameters
$container : ContainerInterface
Return values
HelpCommand

getIconFactory()

public static getIconFactory(ContainerInterface $container) : IconFactory
Parameters
$container : ContainerInterface
Return values
IconFactory

getIconRegistry()

public static getIconRegistry(ContainerInterface $container) : IconRegistry
Parameters
$container : ContainerInterface
Return values
IconRegistry

getIcons()

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

getListCommand()

public static getListCommand(ContainerInterface $container) : ListCommand
Parameters
$container : ContainerInterface
Return values
ListCommand

getLocales()

public static getLocales(ContainerInterface $container) : Locales
Parameters
$container : ContainerInterface
Return values
Locales

getMiddlewares()

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

getRegistry()

public static getRegistry(ContainerInterface $container) : Registry
Parameters
$container : ContainerInterface
Return values
Registry

getSymfonyEventDispatcher()

public static getSymfonyEventDispatcher(ContainerInterface $container) : EventDispatcherInterface
Parameters
$container : ContainerInterface
Return values
EventDispatcherInterface

getTimeTracker()

public static getTimeTracker(ContainerInterface $container) : TimeTracker
Parameters
$container : ContainerInterface
Return values
TimeTracker

provideFallbackEventDispatcher()

public static provideFallbackEventDispatcher(ContainerInterface $container[, EventDispatcherInterface|null $eventDispatcher = null ]) : EventDispatcherInterface
Parameters
$container : ContainerInterface
$eventDispatcher : EventDispatcherInterface|null = null
Return values
EventDispatcherInterface

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

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