HumHub Documentation (unofficial)

Container extends Component
in package

Application

Container implements a [dependency injection](https://en.wikipedia.org/wiki/Dependency_injection) container.

A dependency injection (DI) container is an object that knows how to instantiate and configure objects and all their dependent objects. For more information about DI, please refer to Martin Fowler's article.

Container supports constructor injection as well as property injection.

To use Container, you first need to set up the class dependencies by calling [[set()]]. You then call [[get()]] to create a new class object. The Container will automatically instantiate dependent objects, inject them into the object being created, configure, and finally return the newly created object.

By default, [[\Yii::$container]] refers to a Container instance which is used by [[\Yii::createObject()]] to create new object instances. You may use this method to replace the new operator when creating a new object, which gives you the benefit of automatic dependency resolution and default property configuration.

Below is an example of using Container:

namespace app\models;

use yii\base\BaseObject;
use yii\db\Connection;
use yii\di\Container;

interface UserFinderInterface
{
    function findUser();
}

class UserFinder extends BaseObject implements UserFinderInterface
{
    public $db;

    public function __construct(Connection $db, $config = [])
    {
        $this->db = $db;
        parent::__construct($config);
    }

    public function findUser()
    {
    }
}

class UserLister extends BaseObject
{
    public $finder;

    public function __construct(UserFinderInterface $finder, $config = [])
    {
        $this->finder = $finder;
        parent::__construct($config);
    }
}

$container = new Container;
$container->set('yii\db\Connection', [
    'dsn' => '...',
]);
$container->set('app\models\UserFinderInterface', [
    'class' => 'app\models\UserFinder',
]);
$container->set('userLister', 'app\models\UserLister');

$lister = $container->get('userLister');

// which is equivalent to:

$db = new \yii\db\Connection(['dsn' => '...']);
$finder = new UserFinder($db);
$lister = new UserLister($finder);

For more details and usage information on Container, see the guide article on di-containers.

Properties

$behaviors : array<string|int, Behavior>
$definitions : array<string|int, mixed>
$resolveArrays : bool
$_behaviors : array<string|int, Behavior>|null
$_definitions : array<string|int, mixed>
$_dependencies : array<string|int, mixed>
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_params : array<string|int, mixed>
$_reflections : array<string|int, mixed>
$_resolveArrays : bool
$_singletons : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
clear() : mixed: Removes the definition for the specified name.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
get() : object: Returns an instance of the requested class.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getDefinitions() : array<string|int, mixed>: Returns the list of the object definitions or the loaded shared objects.
has() : bool: Returns a value indicating whether the container has the definition of the specified name.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
hasSingleton() : bool: Returns a value indicating whether the given name corresponds to a registered singleton.
init() : mixed: Initializes the object.
invoke() : mixed: Invoke a callback with resolving dependencies in parameters.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
resolveCallableDependencies() : array<string|int, mixed>: Resolve dependencies for a function.
set() : $this: Registers a class definition with this container.
setDefinitions() : mixed: Registers class definitions within this container.
setResolveArrays() : mixed
setSingleton() : $this: Registers a class definition with this container and marks the class as a singleton class.
setSingletons() : mixed: Registers class definitions as singletons within this container by calling [[setSingleton()]].
trigger() : mixed: Triggers an event.
build() : object: Creates an instance of the specified class.
getDependencies() : array<string|int, mixed>: Returns the dependencies of the specified class.
mergeParams() : array<string|int, mixed>: Merges the user-specified constructor parameters with the ones registered via [[set()]].
normalizeDefinition() : array<string|int, mixed>: Normalizes the class definition.
resolveDependencies() : array<string|int, mixed>: Resolves dependencies by replacing them with the actual object instances.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
isNulledParam() : bool
mergeDependencies() : array<string|int, mixed>
validateDependencies() : mixed

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$definitions read-only


    public
        array<string|int, mixed>
    $definitions

The list of the object definitions or the loaded shared objects (type or ID => definition or instance).

$resolveArrays write-only


    public
        bool
    $resolveArrays

Whether to attempt to resolve elements in array dependencies.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_definitions


    private
        array<string|int, mixed>
    $_definitions
     = []

object definitions indexed by their types

$_dependencies


    private
        array<string|int, mixed>
    $_dependencies
     = []

cached dependencies indexed by class/interface names. Each class name is associated with a list of constructor parameter types or default values.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_params


    private
        array<string|int, mixed>
    $_params
     = []

constructor parameters indexed by object types

$_reflections


    private
        array<string|int, mixed>
    $_reflections
     = []

cached ReflectionClass objects indexed by class/interface names

$_resolveArrays


    private
        bool
    $_resolveArrays
     = false

whether to attempt to resolve elements in array dependencies

$_singletons


    private
        array<string|int, mixed>
    $_singletons
     = []

singleton objects indexed by their types

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.


    public
                    __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a getter: return the getter result
a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

This method will check in the following order and act accordingly:

a property defined by a setter: return whether the property is set
a property of a behavior: return whether the property is set
return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value
an event in the format of "on xyz": attach the handler to the event "xyz"
a behavior in the format of "as xyz": attach the behavior named as "xyz"
a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

This method will check in the following order and act accordingly:

a property defined by a setter: set the property value to be null
a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters

$name : string: the property name

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

behaviors()

Returns a list of behaviors that this component should behave as.


    public
                    behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values

array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a readable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a writable property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

clear()

Removes the definition for the specified name.


    public
                    clear(string $class) : mixed

Parameters

$class : string: class name, interface name or alias name

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.


    public
                    ensureBehaviors() : mixed

get()

Returns an instance of the requested class.


    public
                    get(string|Instance $class[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $config = [] ]) : object

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.

Parameters

$class : string|Instance

the class Instance, name, or an alias name (e.g. foo) that was previously registered via [[set()]] or [[setSingleton()]].

$params : array<string|int, mixed> = []

a list of constructor parameter values. Use one of two definitions:

Parameters as name-value pairs, for example: ['posts' => PostRepository::class].
Parameters in the order they appear in the constructor declaration. If you want to skip some parameters, you should index the remaining ones with the integers that represent their positions in the constructor parameter list. Dependencies indexed by name and by position in the same array are not allowed.

$config : array<string|int, mixed> = []

a list of name-value pairs that will be used to initialize the object properties.

Return values

object —

an instance of the requested class.

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getDefinitions()

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


    public
                    getDefinitions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the list of the object definitions or the loaded shared objects (type or ID => definition or instance).

has()

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


    public
                    has(string $class) : bool

Parameters

$class : string: class name, interface name or alias name

Return values

bool —

Whether the container has the definition of the specified name.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

the class has a method with the specified name
an attached behavior has a method with the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);
an attached behavior has a property of the given name (when $checkBehaviors is true).

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

hasSingleton()

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


    public
                    hasSingleton(string $class[, bool $checkInstance = false ]) : bool

Parameters

$class : string: class name, interface name or alias name
$checkInstance : bool = false: whether to check if the singleton has been instantiated.

Return values

bool —

whether the given name corresponds to a registered singleton. If $checkInstance is true, the method should return a value indicating whether the singleton has been instantiated.

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

invoke()

Invoke a callback with resolving dependencies in parameters.


    public
                    invoke(callable $callback[, array<string|int, mixed> $params = [] ]) : mixed

This method allows invoking a callback and let type hinted parameter names to be resolved as objects of the Container. It additionally allows 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.

Parameters

$callback : callable: callable to be invoked.
$params : array<string|int, mixed> = []: The array of parameters for the function. This can be either a list of parameters, or an associative array representing named function parameters.

Return values

mixed —

the callback return value.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].
$append : bool = true: whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

resolveCallableDependencies()

Resolve dependencies for a function.


    public
                    resolveCallableDependencies(callable $callback[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

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

Parameters

$callback : callable: callable to be invoked.
$params : array<string|int, mixed> = []: The array of parameters for the function, can be either numeric or associative.

Return values

array<string|int, mixed> —

The resolved dependencies.

set()

Registers a class definition with this container.


    public
                    set(string $class[, mixed $definition = [] ][, array<string|int, mixed> $params = [] ]) : $this

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.

Parameters

$class : string

class name, interface name or alias name

$definition : mixed = []

the definition associated with $class. It can be one of the following:

a PHP callable: The callable will be executed when [[get()]] is invoked. The signature of the callable should be function ($container, $params, $config), where $params stands for the list of constructor parameters, $config the object configuration, and $container the container object. The return value of the callable will be returned by [[get()]] as the object instance requested.
a configuration array: the array contains name-value pairs that will be used to initialize the property values of the newly created object when [[get()]] is called. The class element stands for the class of the object to be created. If class is not specified, $class will be used as the class name.
a string: a class name, an interface name or an alias name.

$params : array<string|int, mixed> = []

the list of constructor parameters. The parameters will be passed to the class constructor when [[get()]] is called.

Return values

$this —

the container itself

setDefinitions()

Registers class definitions within this container.


    public
                    setDefinitions(array<string|int, mixed> $definitions) : mixed

Parameters

$definitions : array<string|int, mixed>

array of definitions. There are two allowed formats of array. The first format:

key: class name, interface name or alias name. The key will be passed to the [[set()]] method as a first argument $class.
value: the definition associated with $class. Possible values are described in [[set()]] documentation for the $definition parameter. Will be passed to the [[set()]] method as the second argument $definition.

Example:

$container->setDefinitions([
    '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);
    }
]);

The second format:

key: class name, interface name or alias name. The key will be passed to the [[set()]] method as a first argument $class.
value: array of two elements. The first element will be passed the [[set()]] method as the second argument $definition, the second one — as $params.

Example:

$container->setDefinitions([
    'foo\Bar' => [
         ['class' => 'app\Bar'],
         [Instance::of('baz')]
     ]
]);

setResolveArrays()


    public
                    setResolveArrays(bool $value) : mixed

Parameters

$value : bool: whether to attempt to resolve elements in array dependencies

setSingleton()

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


    public
                    setSingleton(string $class[, mixed $definition = [] ][, array<string|int, mixed> $params = [] ]) : $this

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.

Parameters

$class : string: class name, interface name or alias name
$definition : mixed = []: the definition associated with $class. See [[set()]] for more details.
$params : array<string|int, mixed> = []: the list of constructor parameters. The parameters will be passed to the class constructor when [[get()]] is called.

Return values

$this —

the container itself

setSingletons()

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


    public
                    setSingletons(array<string|int, mixed> $singletons) : mixed

Parameters

$singletons : array<string|int, mixed>: array of singleton definitions. See [[setDefinitions()]] for allowed formats of array.

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

build()

Creates an instance of the specified class.


    protected
                    build(string $class, array<string|int, mixed> $params, array<string|int, mixed> $config) : object

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

Parameters

$class : string: the class name
$params : array<string|int, mixed>: constructor parameters
$config : array<string|int, mixed>: configurations to be applied to the new instance

Return values

object —

the newly created instance of the specified class

getDependencies()

Returns the dependencies of the specified class.


    protected
                    getDependencies(string $class) : array<string|int, mixed>

Parameters

$class : string: class name, interface name or alias name

Return values

array<string|int, mixed> —

the dependencies of the specified class.

mergeParams()

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


    protected
                    mergeParams(string $class, array<string|int, mixed> $params) : array<string|int, mixed>

Parameters

$class : string: class name, interface name or alias name
$params : array<string|int, mixed>: the constructor parameters

Return values

array<string|int, mixed> —

the merged parameters

normalizeDefinition()

Normalizes the class definition.


    protected
                    normalizeDefinition(string $class, string|array<string|int, mixed>|callable $definition) : array<string|int, mixed>

Parameters

$class : string: class name
$definition : string|array<string|int, mixed>|callable: the class definition

Return values

array<string|int, mixed> —

the normalized class definition

resolveDependencies()

Resolves dependencies by replacing them with the actual object instances.


    protected
                    resolveDependencies(array<string|int, mixed> $dependencies[, ReflectionClass|null $reflection = null ]) : array<string|int, mixed>

Parameters

$dependencies : array<string|int, mixed>: the dependencies
$reflection : ReflectionClass|null = null: the class reflection associated with the dependencies

Return values

array<string|int, mixed> —

the resolved dependencies

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

isNulledParam()


    private
                    isNulledParam(ReflectionParameter $param) : bool

Parameters

$param : ReflectionParameter

Return values

bool

mergeDependencies()


    private
                    mergeDependencies(array<string|int, mixed> $a, array<string|int, mixed> $b) : array<string|int, mixed>

Parameters

$a : array<string|int, mixed>
$b : array<string|int, mixed>

Return values

array<string|int, mixed>

validateDependencies()


    private
                    validateDependencies(array<string|int, mixed> $parameters) : mixed

Parameters

$parameters : array<string|int, mixed>

Container extends Component in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$definitions read-only

$resolveArrays write-only

$_behaviors

$_definitions

$_dependencies

$_events

$_eventWildcards

Tags

$_params

$_reflections

$_resolveArrays

$_singletons

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

clear()

Parameters

detachBehavior()

Parameters

Return values

detachBehaviors()

ensureBehaviors()

get()

Parameters

Tags

Return values

getBehavior()

Container extends Component
in package

Application