ServiceProvider extends AbstractServiceProvider
Table of Contents
Methods
- configureBackendModules() : ArrayObject
- configureBackendRoutes() : ArrayObject
- configureCommands() : CommandRegistry
- configureContentSecurityPolicies() : Map<Scope, Map<MutationOrigin, MutationCollection>>
- configureIconRegistry() : IconRegistry
- configureIcons() : ArrayObject
- configureMiddlewares() : ArrayObject
- configureSetCollector() : SetCollector
- extendEventListenerProvider() : ListenerProvider
- getAssetsCache() : FrontendInterface
- 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
- getCoreMiddlewares() : ArrayObject
- getDependencyOrderingService() : DependencyOrderingService
- getDriverMiddlewaresService() : DriverMiddlewareService
- 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
- getFileNameValidator() : FileNameValidator
- getFlashMessageService() : FlashMessageService
- getFlexFormService() : FlexFormService
- getFormProtectionFactory() : FormProtectionFactory
- getGuzzleClientFactory() : GuzzleClientFactory
- getHashService() : HashService
- getHelpCommand() : HelpCommand
- getHttpApplication() : Application
- getHttpRequestHandler() : RequestHandler
- 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
- getRuntimeCache() : FrontendInterface
- getSchemaMigrator() : SchemaMigrator
- getSchemaParser() : Parser
- getSiteWriter() : SiteWriter
- getStorageRepository() : StorageRepository
- getSymfonyEventDispatcher() : EventDispatcherInterface
- getSymfonyLintCommand() : LintCommand
- getTypoScriptService() : TypoScriptService
- getTypoScriptStringFactory() : TypoScriptStringFactory
- getVerifyHostHeaderMiddleware() : VerifyHostHeader
- getYamlFileLoader() : YamlFileLoader
- 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
ArrayObjectconfigureBackendRoutes()
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
ArrayObjectconfigureCommands()
public
static configureCommands(ContainerInterface $container, CommandRegistry $commandRegistry) : CommandRegistry
Parameters
- $container : ContainerInterface
- $commandRegistry : CommandRegistry
Return values
CommandRegistryconfigureContentSecurityPolicies()
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>>configureIconRegistry()
public
static configureIconRegistry(ContainerInterface $container, IconRegistry $iconRegistry) : IconRegistry
Parameters
- $container : ContainerInterface
- $iconRegistry : IconRegistry
Return values
IconRegistryconfigureIcons()
public
static configureIcons(ContainerInterface $container, ArrayObject $icons[, string|null $path = null ]) : ArrayObject
Parameters
- $container : ContainerInterface
- $icons : ArrayObject
- $path : string|null = null
Return values
ArrayObjectconfigureMiddlewares()
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
ArrayObjectconfigureSetCollector()
public
static configureSetCollector(ContainerInterface $container, SetCollector $setCollector[, string|null $path = null ]) : SetCollector
Parameters
- $container : ContainerInterface
- $setCollector : SetCollector
- $path : string|null = null
Return values
SetCollectorextendEventListenerProvider()
public
static extendEventListenerProvider(ContainerInterface $container, ListenerProvider $listenerProvider) : ListenerProvider
Parameters
- $container : ContainerInterface
- $listenerProvider : ListenerProvider
Return values
ListenerProvidergetAssetsCache()
public
static getAssetsCache(ContainerInterface $container) : FrontendInterface
Parameters
- $container : ContainerInterface
Return values
FrontendInterfacegetAstTraverser()
public
static getAstTraverser(ContainerInterface $container) : AstTraverser
Parameters
- $container : ContainerInterface
Return values
AstTraversergetBackendEntryPointResolver()
public
static getBackendEntryPointResolver(ContainerInterface $container) : BackendEntryPointResolver
Parameters
- $container : ContainerInterface
Return values
BackendEntryPointResolvergetBootService()
public
static getBootService(ContainerInterface $container) : BootService
Parameters
- $container : ContainerInterface
Return values
BootServicegetCacheFlushCommand()
public
static getCacheFlushCommand(ContainerInterface $container) : CacheFlushCommand
Parameters
- $container : ContainerInterface
Return values
CacheFlushCommandgetCacheManager()
public
static getCacheManager(ContainerInterface $container) : CacheManager
Parameters
- $container : ContainerInterface
Return values
CacheManagergetCacheWarmupCommand()
public
static getCacheWarmupCommand(ContainerInterface $container) : CacheWarmupCommand
Parameters
- $container : ContainerInterface
Return values
CacheWarmupCommandgetCharsetConverter()
public
static getCharsetConverter(ContainerInterface $container) : CharsetConverter
Parameters
- $container : ContainerInterface
Return values
CharsetConvertergetCommentAwareAstBuilder()
public
static getCommentAwareAstBuilder(ContainerInterface $container) : CommentAwareAstBuilder
Parameters
- $container : ContainerInterface
Return values
CommentAwareAstBuildergetConnectionPool()
public
static getConnectionPool(ContainerInterface $container) : ConnectionPool
Parameters
- $container : ContainerInterface
Return values
ConnectionPoolgetConsoleCommandApplication()
public
static getConsoleCommandApplication(ContainerInterface $container) : CommandApplication
Parameters
- $container : ContainerInterface
Return values
CommandApplicationgetConsoleCommandRegistry()
public
static getConsoleCommandRegistry(ContainerInterface $container) : CommandRegistry
Parameters
- $container : ContainerInterface
Return values
CommandRegistrygetContentSecurityPolicies()
public
static getContentSecurityPolicies(ContainerInterface $container) : Map
Parameters
- $container : ContainerInterface
Return values
MapgetContext()
public
static getContext(ContainerInterface $container) : Context
Parameters
- $container : ContainerInterface
Return values
ContextgetCoreMiddlewares()
public
static getCoreMiddlewares(ContainerInterface $container) : ArrayObject
Parameters
- $container : ContainerInterface
Return values
ArrayObjectgetDependencyOrderingService()
public
static getDependencyOrderingService(ContainerInterface $container) : DependencyOrderingService
Parameters
- $container : ContainerInterface
Return values
DependencyOrderingServicegetDriverMiddlewaresService()
public
static getDriverMiddlewaresService(ContainerInterface $container) : DriverMiddlewareService
Parameters
- $container : ContainerInterface
Return values
DriverMiddlewareServicegetDriverRegistry()
public
static getDriverRegistry(ContainerInterface $container) : DriverRegistry
Parameters
- $container : ContainerInterface
Return values
DriverRegistrygetDumpAutoloadCommand()
public
static getDumpAutoloadCommand(ContainerInterface $container) : DumpAutoloadCommand
Parameters
- $container : ContainerInterface
Return values
DumpAutoloadCommandgetEventDispatcher()
public
static getEventDispatcher(ContainerInterface $container) : EventDispatcher
Parameters
- $container : ContainerInterface
Return values
EventDispatchergetEventListenerProvider()
public
static getEventListenerProvider(ContainerInterface $container) : ListenerProvider
Parameters
- $container : ContainerInterface
Return values
ListenerProvidergetExtensions()
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>getFailsafePackageManager()
public
static getFailsafePackageManager(ContainerInterface $container) : FailsafePackageManager
Parameters
- $container : ContainerInterface
Return values
FailsafePackageManagergetFileIndexRepository()
public
static getFileIndexRepository(ContainerInterface $container) : FileIndexRepository
Parameters
- $container : ContainerInterface
Return values
FileIndexRepositorygetFileNameValidator()
public
static getFileNameValidator(ContainerInterface $container) : FileNameValidator
Parameters
- $container : ContainerInterface
Return values
FileNameValidatorgetFlashMessageService()
public
static getFlashMessageService(ContainerInterface $container) : FlashMessageService
Parameters
- $container : ContainerInterface
Return values
FlashMessageServicegetFlexFormService()
public
static getFlexFormService(ContainerInterface $container) : FlexFormService
Parameters
- $container : ContainerInterface
Return values
FlexFormServicegetFormProtectionFactory()
public
static getFormProtectionFactory(ContainerInterface $container) : FormProtectionFactory
Parameters
- $container : ContainerInterface
Return values
FormProtectionFactorygetGuzzleClientFactory()
public
static getGuzzleClientFactory(ContainerInterface $container) : GuzzleClientFactory
Parameters
- $container : ContainerInterface
Return values
GuzzleClientFactorygetHashService()
public
static getHashService() : HashService
Return values
HashServicegetHelpCommand()
public
static getHelpCommand(ContainerInterface $container) : HelpCommand
Parameters
- $container : ContainerInterface
Return values
HelpCommandgetHttpApplication()
public
static getHttpApplication(ContainerInterface $container) : Application
Parameters
- $container : ContainerInterface
Return values
ApplicationgetHttpRequestHandler()
public
static getHttpRequestHandler(ContainerInterface $container) : RequestHandler
Parameters
- $container : ContainerInterface
Return values
RequestHandlergetIconFactory()
public
static getIconFactory(ContainerInterface $container) : IconFactory
Parameters
- $container : ContainerInterface
Return values
IconFactorygetIconRegistry()
public
static getIconRegistry(ContainerInterface $container) : IconRegistry
Parameters
- $container : ContainerInterface
Return values
IconRegistrygetIcons()
public
static getIcons(ContainerInterface $container) : ArrayObject
Parameters
- $container : ContainerInterface
Return values
ArrayObjectgetLanguageServiceFactory()
public
static getLanguageServiceFactory(ContainerInterface $container) : LanguageServiceFactory
Parameters
- $container : ContainerInterface
Return values
LanguageServiceFactorygetLanguageStore()
public
static getLanguageStore(ContainerInterface $container) : LanguageStore
Parameters
- $container : ContainerInterface
Return values
LanguageStoregetListCommand()
public
static getListCommand(ContainerInterface $container) : ListCommand
Parameters
- $container : ContainerInterface
Return values
ListCommandgetLocales()
public
static getLocales(ContainerInterface $container) : Locales
Parameters
- $container : ContainerInterface
Return values
LocalesgetLocalizationFactory()
public
static getLocalizationFactory(ContainerInterface $container) : LocalizationFactory
Parameters
- $container : ContainerInterface
Return values
LocalizationFactorygetLosslessTokenizer()
public
static getLosslessTokenizer(ContainerInterface $container) : LosslessTokenizer
Parameters
- $container : ContainerInterface
Return values
LosslessTokenizergetMailTransportFactory()
public
static getMailTransportFactory(ContainerInterface $container) : TransportFactory
Parameters
- $container : ContainerInterface
Return values
TransportFactorygetMetaDataRepository()
public
static getMetaDataRepository(ContainerInterface $container) : MetaDataRepository
Parameters
- $container : ContainerInterface
Return values
MetaDataRepositorygetMiddlewares()
public
static getMiddlewares(ContainerInterface $container) : ArrayObject
Parameters
- $container : ContainerInterface
Return values
ArrayObjectgetMiddlewareStackResolver()
public
static getMiddlewareStackResolver(ContainerInterface $container) : MiddlewareStackResolver
Parameters
- $container : ContainerInterface
Return values
MiddlewareStackResolvergetOpcodeCacheService()
public
static getOpcodeCacheService(ContainerInterface $container) : OpcodeCacheService
Parameters
- $container : ContainerInterface
Return values
OpcodeCacheServicegetPackageDependentCacheIdentifier()
public
static getPackageDependentCacheIdentifier(ContainerInterface $container) : PackageDependentCacheIdentifier
Parameters
- $container : ContainerInterface
Return values
PackageDependentCacheIdentifiergetPasswordHashFactory()
public
static getPasswordHashFactory(ContainerInterface $container) : PasswordHashFactory
Parameters
- $container : ContainerInterface
Return values
PasswordHashFactorygetProcessedFileRepository()
public
static getProcessedFileRepository(ContainerInterface $container) : ProcessedFileRepository
Parameters
- $container : ContainerInterface
Return values
ProcessedFileRepositorygetRegistry()
public
static getRegistry(ContainerInterface $container) : Registry
Parameters
- $container : ContainerInterface
Return values
RegistrygetRequestContextFactory()
public
static getRequestContextFactory(ContainerInterface $container) : RequestContextFactory
Parameters
- $container : ContainerInterface
Return values
RequestContextFactorygetRequestFactory()
public
static getRequestFactory(ContainerInterface $container) : RequestFactory
Parameters
- $container : ContainerInterface
Return values
RequestFactorygetResourceFactory()
public
static getResourceFactory(ContainerInterface $container) : ResourceFactory
Parameters
- $container : ContainerInterface
Return values
ResourceFactorygetResponsePropagationMiddleware()
public
static getResponsePropagationMiddleware(ContainerInterface $container) : ResponsePropagation
Parameters
- $container : ContainerInterface
Return values
ResponsePropagationgetRuntimeCache()
public
static getRuntimeCache(ContainerInterface $container) : FrontendInterface
Parameters
- $container : ContainerInterface
Return values
FrontendInterfacegetSchemaMigrator()
public
static getSchemaMigrator(ContainerInterface $container) : SchemaMigrator
Parameters
- $container : ContainerInterface
Return values
SchemaMigratorgetSchemaParser()
public
static getSchemaParser(ContainerInterface $container) : Parser
Parameters
- $container : ContainerInterface
Return values
ParsergetSiteWriter()
public
static getSiteWriter(ContainerInterface $container) : SiteWriter
Parameters
- $container : ContainerInterface
Return values
SiteWritergetStorageRepository()
public
static getStorageRepository(ContainerInterface $container) : StorageRepository
Parameters
- $container : ContainerInterface
Return values
StorageRepositorygetSymfonyEventDispatcher()
public
static getSymfonyEventDispatcher(ContainerInterface $container) : EventDispatcherInterface
Parameters
- $container : ContainerInterface
Return values
EventDispatcherInterfacegetSymfonyLintCommand()
public
static getSymfonyLintCommand(ContainerInterface $container) : LintCommand
Parameters
- $container : ContainerInterface
Return values
LintCommandgetTypoScriptService()
public
static getTypoScriptService(ContainerInterface $container) : TypoScriptService
Parameters
- $container : ContainerInterface
Return values
TypoScriptServicegetTypoScriptStringFactory()
public
static getTypoScriptStringFactory(ContainerInterface $container) : TypoScriptStringFactory
Parameters
- $container : ContainerInterface
Return values
TypoScriptStringFactorygetVerifyHostHeaderMiddleware()
public
static getVerifyHostHeaderMiddleware(ContainerInterface $container) : VerifyHostHeader
Parameters
- $container : ContainerInterface
Return values
VerifyHostHeadergetYamlFileLoader()
public
static getYamlFileLoader(ContainerInterface $container) : YamlFileLoader
Parameters
- $container : ContainerInterface
Return values
YamlFileLoaderprovideFallbackEventDispatcher()
public
static provideFallbackEventDispatcher(ContainerInterface $container[, EventDispatcherInterface|null $eventDispatcher = null ]) : EventDispatcherInterface
Parameters
- $container : ContainerInterface
- $eventDispatcher : EventDispatcherInterface|null = null
Return values
EventDispatcherInterfacegetPackageName()
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
stringgetPackagePath()
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
stringnew()
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