IServerContainer
extends
ContainerInterface, IContainer
in
This is a tagging interface for the server container
The interface currently extends IContainer, but this interface is deprecated as of Nextcloud 20, thus this interface won't extend it anymore once that was removed. So migrate to the ContainerInterface only.
Tags
Table of Contents
- createEventSource() : IEventSource
- Create a new event source
- getActivityManager() : IManager
- Returns the activity manager
- getAppConfig() : IAppConfig
- Returns the app config manager
- getAppManager() : IAppManager
- Get the app manager
- getAvatarManager() : IAvatarManager
- Returns an avatar manager, used for avatar functionality
- getCache() : ICache
- Returns an ICache instance
- getCalendarManager() : IManager
- The calendar manager will act as a broker between consumers for calendar information and providers which actual deliver the calendar information.
- getCalendarResourceBackendManager() : IBackend
- The calendar resource backend manager will act as a broker between consumers for calendar resource information an providers which actual deliver the room information.
- getCalendarRoomBackendManager() : IBackend
- The calendar room backend manager will act as a broker between consumers for calendar room information an providers which actual deliver the room information.
- getCertificateManager() : ICertificateManager
- Get the certificate manager for the user
- getCloudFederationFactory() : ICloudFederationFactory
- getCloudFederationProviderManager() : ICloudFederationProviderManager
- getCloudIdManager() : ICloudIdManager
- getCommandBus() : IBus
- getCommentsManager() : ICommentsManager
- getConfig() : IConfig
- Returns the config manager
- getContactsManager() : IManager
- The contacts manager will act as a broker between consumers for contacts information and providers which actual deliver the contact information.
- getContentSecurityPolicyManager() : IContentSecurityPolicyManager
- getCredentialsManager() : ICredentialsManager
- Returns a CredentialsManager instance
- getCrypto() : ICrypto
- Returns a Crypto instance
- getDatabaseConnection() : IDBConnection
- Returns the current session
- getDateTimeFormatter() : IDateTimeFormatter
- getDateTimeZone() : IDateTimeZone
- getEncryptionFilesHelper() : File
- getEncryptionKeyStorage() : IStorage
- getEncryptionManager() : Manager
- getEventDispatcher() : EventDispatcherInterface
- Get the EventDispatcher
- getEventLogger() : IEventLogger
- Get the active event logger
- getGlobalScaleConfig() : IConfig
- getGroupManager() : IGroupManager
- Returns a group manager
- getHasher() : IHasher
- Returns a Hasher instance
- getHTTPClientService() : IClientService
- Returns an instance of the HTTP client service
- getIniWrapper() : IniGetWrapper
- Get the IniWrapper
- getJobList() : IJobList
- Returns an job list for controlling background jobs
- getL10N() : IL10N
- get an L10N instance
- getL10NFactory() : IFactory
- getLockingProvider() : ILockingProvider
- Get the locking provider
- getLogFactory() : ILogFactory
- returns a log factory instance
- getLogger() : ILogger
- Returns a logger instance
- getMailer() : IMailer
- Creates a new mailer
- getMemCacheFactory() : ICacheFactory
- Returns an \OCP\CacheFactory instance
- getMimeTypeDetector() : IMimeTypeDetector
- Get the MimeTypeDetector
- getMimeTypeLoader() : IMimeTypeLoader
- Get the MimeTypeLoader
- getMountManager() : IMountManager
- getMountProviderCollection() : IMountProviderCollection
- getNavigationManager() : INavigationManager
- Returns the navigation manager
- getNotificationManager() : IManager
- Get the Notification Manager
- getPreviewManager() : IPreview
- Returns the preview manager which can create preview images for a given file
- getQueryLogger() : IQueryLogger
- Get the active query logger
- getRemoteApiFactory() : IApiFactory
- getRemoteInstanceFactory() : IInstanceFactory
- getRequest() : IRequest
- The current request object holding all information about the request currently being processed is returned from this method.
- getRootFolder() : IRootFolder
- Returns the root folder of ownCloud's data directory
- getRouter() : IRouter
- Returns a router for generating and matching urls
- getSearch() : ISearch
- Returns a search instance
- getSecureRandom() : ISecureRandom
- Returns a SecureRandom instance
- getSession() : ISession
- Returns the current session
- getShareManager() : IManager
- Returns the share manager
- getStorageFactory() : IStorageFactory
- getSystemTagManager() : ISystemTagManager
- Returns the system-tag manager
- getSystemTagObjectMapper() : ISystemTagObjectMapper
- Returns the system-tag object mapper
- getTagManager() : ITagManager
- Returns the tag manager which can get and set tags for different object types
- getTempManager() : ITempManager
- Get the manager for temporary files and folders
- getURLGenerator() : IURLGenerator
- Returns the URL generator
- getUserFolder() : Folder
- Returns a view to ownCloud's files folder
- getUserManager() : IUserManager
- Returns a user manager
- getUserSession() : IUserSession
- Returns the user session
- getWebRoot() : string
- Get the webroot
- query() : mixed
- Look up a service for a given name in the container.
- registerAlias() : mixed
- Shortcut for returning a service from a service under a different key, e.g. to tell the container to return a class when queried for an interface
- registerParameter() : void
- A value is stored in the container with it's corresponding name
- registerService() : void
- A service is registered in the container where a closure is passed in which will actually create the service on demand.
- resolve() : stdClass
- If a parameter is not registered in the container try to instantiate it by using reflection to find out how to build the class
Methods
createEventSource()
Create a new event source
public
createEventSource() : IEventSource
Tags
Return values
IEventSource —getActivityManager()
Returns the activity manager
public
getActivityManager() : IManager
Tags
Return values
IManager —getAppConfig()
Returns the app config manager
public
getAppConfig() : IAppConfig
Tags
Return values
IAppConfig —getAppManager()
Get the app manager
public
getAppManager() : IAppManager
Tags
Return values
IAppManager —getAvatarManager()
Returns an avatar manager, used for avatar functionality
public
getAvatarManager() : IAvatarManager
Tags
Return values
IAvatarManager —getCache()
Returns an ICache instance
public
getCache() : ICache
Tags
Return values
ICache —getCalendarManager()
The calendar manager will act as a broker between consumers for calendar information and providers which actual deliver the calendar information.
public
getCalendarManager() : IManager
Tags
Return values
IManager —getCalendarResourceBackendManager()
The calendar resource backend manager will act as a broker between consumers for calendar resource information an providers which actual deliver the room information.
public
getCalendarResourceBackendManager() : IBackend
Tags
Return values
IBackend —getCalendarRoomBackendManager()
The calendar room backend manager will act as a broker between consumers for calendar room information an providers which actual deliver the room information.
public
getCalendarRoomBackendManager() : IBackend
Tags
Return values
IBackend —getCertificateManager()
Get the certificate manager for the user
public
getCertificateManager([string $userId = null ]) : ICertificateManager
Parameters
- $userId : string = null
-
(optional) if not specified the current loggedin user is used, use null to get the system certificate manager
Tags
Return values
ICertificateManager —| null if $userId is null and no user is logged in
getCloudFederationFactory()
public
getCloudFederationFactory() : ICloudFederationFactory
Tags
Return values
ICloudFederationFactory —getCloudFederationProviderManager()
public
getCloudFederationProviderManager() : ICloudFederationProviderManager
Tags
Return values
ICloudFederationProviderManager —getCloudIdManager()
public
getCloudIdManager() : ICloudIdManager
Tags
Return values
ICloudIdManager —getCommandBus()
public
getCommandBus() : IBus
Tags
Return values
IBus —getCommentsManager()
public
getCommentsManager() : ICommentsManager
Tags
Return values
ICommentsManager —getConfig()
Returns the config manager
public
getConfig() : IConfig
Tags
Return values
IConfig —getContactsManager()
The contacts manager will act as a broker between consumers for contacts information and providers which actual deliver the contact information.
public
getContactsManager() : IManager
Tags
Return values
IManager —getContentSecurityPolicyManager()
public
getContentSecurityPolicyManager() : IContentSecurityPolicyManager
Tags
Return values
IContentSecurityPolicyManager —getCredentialsManager()
Returns a CredentialsManager instance
public
getCredentialsManager() : ICredentialsManager
Tags
Return values
ICredentialsManager —getCrypto()
Returns a Crypto instance
public
getCrypto() : ICrypto
Tags
Return values
ICrypto —getDatabaseConnection()
Returns the current session
public
getDatabaseConnection() : IDBConnection
Tags
Return values
IDBConnection —getDateTimeFormatter()
public
getDateTimeFormatter() : IDateTimeFormatter
Tags
Return values
IDateTimeFormatter —getDateTimeZone()
public
getDateTimeZone() : IDateTimeZone
Tags
Return values
IDateTimeZone —getEncryptionFilesHelper()
public
getEncryptionFilesHelper() : File
Tags
Return values
File —getEncryptionKeyStorage()
public
getEncryptionKeyStorage() : IStorage
Tags
Return values
IStorage —getEncryptionManager()
public
getEncryptionManager() : Manager
Tags
Return values
Manager —getEventDispatcher()
Get the EventDispatcher
public
getEventDispatcher() : EventDispatcherInterface
Tags
Return values
EventDispatcherInterface —getEventLogger()
Get the active event logger
public
getEventLogger() : IEventLogger
Tags
Return values
IEventLogger —getGlobalScaleConfig()
public
getGlobalScaleConfig() : IConfig
Tags
Return values
IConfig —getGroupManager()
Returns a group manager
public
getGroupManager() : IGroupManager
Tags
Return values
IGroupManager —getHasher()
Returns a Hasher instance
public
getHasher() : IHasher
Tags
Return values
IHasher —getHTTPClientService()
Returns an instance of the HTTP client service
public
getHTTPClientService() : IClientService
Tags
Return values
IClientService —getIniWrapper()
Get the IniWrapper
public
getIniWrapper() : IniGetWrapper
Tags
Return values
IniGetWrapper —getJobList()
Returns an job list for controlling background jobs
public
getJobList() : IJobList
Tags
Return values
IJobList —getL10N()
get an L10N instance
public
getL10N(string $app[, string $lang = null ]) : IL10N
Parameters
- $app : string
-
appid
- $lang : string = null
Tags
Return values
IL10N —getL10NFactory()
public
getL10NFactory() : IFactory
Tags
Return values
IFactory —getLockingProvider()
Get the locking provider
public
getLockingProvider() : ILockingProvider
Tags
Return values
ILockingProvider —getLogFactory()
returns a log factory instance
public
getLogFactory() : ILogFactory
Tags
Return values
ILogFactory —getLogger()
Returns a logger instance
public
getLogger() : ILogger
Tags
Return values
ILogger —getMailer()
Creates a new mailer
public
getMailer() : IMailer
Tags
Return values
IMailer —getMemCacheFactory()
Returns an \OCP\CacheFactory instance
public
getMemCacheFactory() : ICacheFactory
Tags
Return values
ICacheFactory —getMimeTypeDetector()
Get the MimeTypeDetector
public
getMimeTypeDetector() : IMimeTypeDetector
Tags
Return values
IMimeTypeDetector —getMimeTypeLoader()
Get the MimeTypeLoader
public
getMimeTypeLoader() : IMimeTypeLoader
Tags
Return values
IMimeTypeLoader —getMountManager()
public
getMountManager() : IMountManager
Tags
Return values
IMountManager —getMountProviderCollection()
public
getMountProviderCollection() : IMountProviderCollection
Tags
Return values
IMountProviderCollection —getNavigationManager()
Returns the navigation manager
public
getNavigationManager() : INavigationManager
Tags
Return values
INavigationManager —getNotificationManager()
Get the Notification Manager
public
getNotificationManager() : IManager
Tags
Return values
IManager —getPreviewManager()
Returns the preview manager which can create preview images for a given file
public
getPreviewManager() : IPreview
Tags
Return values
IPreview —getQueryLogger()
Get the active query logger
public
getQueryLogger() : IQueryLogger
The returned logger only logs data when debug mode is enabled
Tags
Return values
IQueryLogger —getRemoteApiFactory()
public
getRemoteApiFactory() : IApiFactory
Tags
Return values
IApiFactory —getRemoteInstanceFactory()
public
getRemoteInstanceFactory() : IInstanceFactory
Tags
Return values
IInstanceFactory —getRequest()
The current request object holding all information about the request currently being processed is returned from this method.
public
getRequest() : IRequest
In case the current execution was not initiated by a web request null is returned
Tags
Return values
IRequest —getRootFolder()
Returns the root folder of ownCloud's data directory
public
getRootFolder() : IRootFolder
Tags
Return values
IRootFolder —getRouter()
Returns a router for generating and matching urls
public
getRouter() : IRouter
Tags
Return values
IRouter —getSearch()
Returns a search instance
public
getSearch() : ISearch
Tags
Return values
ISearch —getSecureRandom()
Returns a SecureRandom instance
public
getSecureRandom() : ISecureRandom
Tags
Return values
ISecureRandom —getSession()
Returns the current session
public
getSession() : ISession
Tags
Return values
ISession —getShareManager()
Returns the share manager
public
getShareManager() : IManager
Tags
Return values
IManager —getStorageFactory()
public
getStorageFactory() : IStorageFactory
Tags
Return values
IStorageFactory —getSystemTagManager()
Returns the system-tag manager
public
getSystemTagManager() : ISystemTagManager
Tags
Return values
ISystemTagManager —getSystemTagObjectMapper()
Returns the system-tag object mapper
public
getSystemTagObjectMapper() : ISystemTagObjectMapper
Tags
Return values
ISystemTagObjectMapper —getTagManager()
Returns the tag manager which can get and set tags for different object types
public
getTagManager() : ITagManager
Tags
Return values
ITagManager —getTempManager()
Get the manager for temporary files and folders
public
getTempManager() : ITempManager
Tags
Return values
ITempManager —getURLGenerator()
Returns the URL generator
public
getURLGenerator() : IURLGenerator
Tags
Return values
IURLGenerator —getUserFolder()
Returns a view to ownCloud's files folder
public
getUserFolder([string $userId = null ]) : Folder
Parameters
- $userId : string = null
-
user ID
Tags
Return values
Folder —getUserManager()
Returns a user manager
public
getUserManager() : IUserManager
Tags
Return values
IUserManager —getUserSession()
Returns the user session
public
getUserSession() : IUserSession
Tags
Return values
IUserSession —getWebRoot()
Get the webroot
public
getWebRoot() : string
Tags
Return values
string —query()
Look up a service for a given name in the container.
public
query(string $name[, bool $autoload = true ]) : mixed
Parameters
- $name : string
- $autoload : bool = true
-
Should we try to autoload the service. If we are trying to resolve built in types this makes no sense for example
Tags
Return values
mixed —registerAlias()
Shortcut for returning a service from a service under a different key, e.g. to tell the container to return a class when queried for an interface
public
registerAlias(string $alias, string $target) : mixed
Parameters
- $alias : string
-
the alias that should be registered
- $target : string
-
the target that should be resolved instead
Tags
Return values
mixed —registerParameter()
A value is stored in the container with it's corresponding name
public
registerParameter(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed
Tags
registerService()
A service is registered in the container where a closure is passed in which will actually create the service on demand.
public
registerService(string $name, Closure $closure[, bool $shared = true ]) : void
In case the parameter $shared is set to true (the default usage) the once created service will remain in memory and be reused on subsequent calls. In case the parameter is false the service will be recreated on every call.
Parameters
- $name : string
- $closure : Closure
- $shared : bool = true
Tags
resolve()
If a parameter is not registered in the container try to instantiate it by using reflection to find out how to build the class
public
resolve(string $name) : stdClass
Parameters
- $name : string
-
the class name to resolve