Nextcloud PHP API (master)

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
since
6.0.0

Table of Contents

Methods

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
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
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
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
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

Methods

getActivityManager()

Returns the activity manager

public getActivityManager() : IManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IManager

getAppConfig()

Returns the app config manager

public getAppConfig() : IAppConfig

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
7.0.0
Return values
IAppConfig

getAppManager()

Get the app manager

public getAppManager() : IAppManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IAppManager

getAvatarManager()

Returns an avatar manager, used for avatar functionality

public getAvatarManager() : IAvatarManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IAvatarManager

getCache()

Returns an ICache instance

public getCache() : ICache

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
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

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
13.0.0
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

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
14.0.0
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

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
14.0.0
Return values
IBackend

getCommandBus()

public getCommandBus() : IBus

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
IBus

getConfig()

Returns the config manager

public getConfig() : IConfig

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
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

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IManager

getCrypto()

Returns a Crypto instance

public getCrypto() : ICrypto

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
ICrypto

getDatabaseConnection()

Returns the current session

public getDatabaseConnection() : IDBConnection

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IDBConnection

getEncryptionFilesHelper()

public getEncryptionFilesHelper() : File

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
File

getEncryptionKeyStorage()

public getEncryptionKeyStorage() : IStorage

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
IStorage

getEncryptionManager()

public getEncryptionManager() : Manager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
Manager

getEventLogger()

Get the active event logger

public getEventLogger() : IEventLogger

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IEventLogger

getGlobalScaleConfig()

public getGlobalScaleConfig() : IConfig

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
14.0.0
Return values
IConfig

getGroupManager()

Returns a group manager

public getGroupManager() : IGroupManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IGroupManager

getHasher()

Returns a Hasher instance

public getHasher() : IHasher

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IHasher

getHTTPClientService()

Returns an instance of the HTTP client service

public getHTTPClientService() : IClientService

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
IClientService

getIniWrapper()

Get the IniWrapper

public getIniWrapper() : IniGetWrapper

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IniGetWrapper

getJobList()

Returns an job list for controlling background jobs

public getJobList() : IJobList

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
7.0.0
Return values
IJobList

getL10N()

get an L10N instance

public getL10N(string $app[, string $lang = null ]) : IL10N

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Parameters
$app : string

appid

$lang : string = null
Tags
since
6.0.0
  • parameter $lang was added in 8.0.0
Return values
IL10N

getL10NFactory()

public getL10NFactory() : IFactory

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.2.0
Return values
IFactory

getLogFactory()

returns a log factory instance

public getLogFactory() : ILogFactory

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
14.0.0
Return values
ILogFactory

getMailer()

Creates a new mailer

public getMailer() : IMailer

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
IMailer

getMemCacheFactory()

Returns an \OCP\CacheFactory instance

public getMemCacheFactory() : ICacheFactory

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
7.0.0
Return values
ICacheFactory

getNotificationManager()

Get the Notification Manager

public getNotificationManager() : IManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
9.0.0
Return values
IManager

getPreviewManager()

Returns the preview manager which can create preview images for a given file

public getPreviewManager() : IPreview

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IPreview

getQueryLogger()

Get the active query logger

public getQueryLogger() : IQueryLogger

have it injected or fetch it through \Psr\Container\ContainerInterface::get

The returned logger only logs data when debug mode is enabled

Tags
since
8.0.0
Return values
IQueryLogger

getRemoteApiFactory()

public getRemoteApiFactory() : IApiFactory

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
13.0.0
Return values
IApiFactory

getRequest()

The current request object holding all information about the request currently being processed is returned from this method.

public getRequest() : IRequest

have it injected or fetch it through \Psr\Container\ContainerInterface::get

In case the current execution was not initiated by a web request null is returned

Tags
since
6.0.0
Return values
IRequest

getRootFolder()

Returns the root folder of ownCloud's data directory

public getRootFolder() : IRootFolder

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
  • between 6.0.0 and 8.0.0 this returned \OCP\Files\Folder
Return values
IRootFolder

getRouter()

Returns a router for generating and matching urls

public getRouter() : IRouter

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
7.0.0
Return values
IRouter

getSecureRandom()

Returns a SecureRandom instance

public getSecureRandom() : ISecureRandom

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.1.0
Return values
ISecureRandom

getSession()

Returns the current session

public getSession() : ISession

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
ISession

getShareManager()

Returns the share manager

public getShareManager() : IManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
9.0.0
Return values
IManager

getTempManager()

Get the manager for temporary files and folders

public getTempManager() : ITempManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
ITempManager

getURLGenerator()

Returns the URL generator

public getURLGenerator() : IURLGenerator

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IURLGenerator

getUserFolder()

Returns a view to ownCloud's files folder

public getUserFolder([string $userId = null ]) : Folder

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Parameters
$userId : string = null

user ID

Tags
since
6.0.0
  • parameter $userId was added in 8.0.0
see
getUserFolder

in \OCP\Files\IRootFolder

Return values
Folder

getUserManager()

Returns a user manager

public getUserManager() : IUserManager

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
IUserManager

getUserSession()

Returns the user session

public getUserSession() : IUserSession

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
6.0.0
Return values
IUserSession

getWebRoot()

Get the webroot

public getWebRoot() : string

have it injected or fetch it through \Psr\Container\ContainerInterface::get

Tags
since
8.0.0
Return values
string

query()

Look up a service for a given name in the container.

public query(string $name[, bool $autoload = true ]) : mixed

use \Psr\Container\ContainerInterface::get

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
template
psalm-param

string|class-string<T> $name

psalm-return

($name is class-string ? T : mixed)

throws
ContainerExceptionInterface

if the query could not be resolved

throws
NotFoundExceptionInterface

if the name could not be found within the container

throws
QueryException

if the query could not be resolved

since
6.0.0

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

use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerServiceAlias

Parameters
$alias : string

the alias that should be registered

$target : string

the target that should be resolved instead

Tags
since
8.2.0

registerParameter()

A value is stored in the container with it's corresponding name

public registerParameter(string $name, mixed $value) : void

use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerParameter

Parameters
$name : string
$value : mixed
Tags
since
6.0.0

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

use \OCP\AppFramework\Bootstrap\IRegistrationContext::registerService

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
since
6.0.0

resolve()

public resolve(string $name) : stdClass

use \Psr\Container\ContainerInterface::get

Parameters
$name : string

the class name to resolve

Tags
template

If a parameter is not registered in the container try to instantiate it by using reflection to find out how to build the class

psalm-param

string|class-string<T> $name

psalm-return

($name is class-string ? T : mixed)

since
8.2.0
throws
ContainerExceptionInterface

if the class could not be found or instantiated

throws
QueryException

if the class could not be found or instantiated

Return values
stdClass 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results