Nextcloud PHP API (master)

IContainer extends ContainerInterface

Class IContainer

use \Psr\Container\ContainerInterface

IContainer is the basic interface to be used for any internal dependency injection mechanism

Tags
since
6.0.0

Table of Contents

Methods

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

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

T

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

T

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