build() protected method

Creates an instance of the specified class.

This method will resolve dependencies of the specified class, instantiate them, and inject them into the new instance of the specified class.

clear() public method

Removes the definition for the specified name.

get() public method

Returns an instance of the requested class.

You may provide constructor parameters ($params) and object configurations ($config) that will be used during the creation of the instance.

If the class implements yii\base\Configurable, the $config parameter will be passed as the last parameter to the class constructor; Otherwise, the configuration will be applied after the object is instantiated.

Note that if the class is declared to be singleton by calling setSingleton(), the same instance of the class will be returned each time this method is called. In this case, the constructor parameters and object configurations will be used only if the class is instantiated the first time.

getDefinitions() public method

Returns the list of the object definitions or the loaded shared objects.

getDependencies() protected method

Returns the dependencies of the specified class.

has() public method

Returns a value indicating whether the container has the definition of the specified name.

See also set().

hasSingleton() public method

Returns a value indicating whether the given name corresponds to a registered singleton.

invoke() public method (available since version 2.0.7)

Invoke a callback with resolving dependencies in parameters.

This methods allows invoking a callback and let type hinted parameter names to be resolved as objects of the Container. It additionally allow calling function using named parameters.

For example, the following callback may be invoked using the Container to resolve the formatter dependency:

$formatString = function($string, \yii\i18n\Formatter $formatter) {
   // ...
}
Yii::$container->invoke($formatString, ['string' => 'Hello World!']);

This will pass the string 'Hello World!' as the first param, and a formatter instance created by the DI container as the second param to the callable.

mergeParams() protected method

Merges the user-specified constructor parameters with the ones registered via set().

normalizeDefinition() protected method

Normalizes the class definition.

resolveCallableDependencies() public method (available since version 2.0.7)

Resolve dependencies for a function.

This method can be used to implement similar functionality as provided by invoke() in other components.

resolveDependencies() protected method

Resolves dependencies by replacing them with the actual object instances.

set() public method

Registers a class definition with this container.

For example,

// register a class name as is. This can be skipped.
$container->set('yii\db\Connection');

// register an interface
// When a class depends on the interface, the corresponding class
// will be instantiated as the dependent object
$container->set('yii\mail\MailInterface', 'yii\swiftmailer\Mailer');

// register an alias name. You can use $container->get('foo')
// to create an instance of Connection
$container->set('foo', 'yii\db\Connection');

// register a class with configuration. The configuration
// will be applied when the class is instantiated by get()
$container->set('yii\db\Connection', [
    'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
]);

// register an alias name with class configuration
// In this case, a "class" element is required to specify the class
$container->set('db', [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=127.0.0.1;dbname=demo',
    'username' => 'root',
    'password' => '',
    'charset' => 'utf8',
]);

// register a PHP callable
// The callable will be executed when $container->get('db') is called
$container->set('db', function ($container, $params, $config) {
    return new \yii\db\Connection($config);
});

If a class definition with the same name already exists, it will be overwritten with the new one. You may use has() to check if a class definition already exists.

setDefinitions() public method (available since version 2.0.11)

Registers class definitions within this container.

See also set() to know more about possible values of definitions.

'yii\web\Request' => 'app\components\Request',
'yii\web\Response' => [
    'class' => 'app\components\Response',
    'format' => 'json'
],
'foo\Bar' => function () {
    $qux = new Qux;
    $foo = new Foo($qux);
    return new Bar($foo);
}

'foo\Bar' => [
     ['class' => 'app\Bar'],
     [Instance::of('baz')]
 ]

setSingleton() public method

Registers a class definition with this container and marks the class as a singleton class.

This method is similar to set() except that classes registered via this method will only have one instance. Each time get() is called, the same instance of the specified class will be returned.

See also set().

setSingletons() public method (available since version 2.0.11)

Registers class definitions as singletons within this container by calling setSingleton()

See also:

• setDefinitions() for allowed formats of $singletons parameter.
• setSingleton() to know more about possible values of definitions.