1 位关注者

类 yii\di\Container

继承关系	yii\di\Container » yii\base\Component » yii\base\BaseObject
实现接口	yii\base\Configurable
可用版本	2.0
源代码	https://github.com/yiisoft/yii2/blob/master/framework/di/Container.php

Container 实现了一个依赖注入容器。

依赖注入 (DI) 容器是一个知道如何实例化和配置对象及其所有依赖对象的实体。有关 DI 的更多信息，请参阅 Martin Fowler 的文章。

Container 支持构造函数注入和属性注入。

要使用 Container，您首先需要通过调用 set() 设置类依赖关系。然后，您调用 get() 来创建一个新的类对象。Container 将自动实例化依赖对象，将它们注入到正在创建的对象中，进行配置，最后返回新创建的对象。

默认情况下，Yii::$container 指向一个 Container 实例，该实例由 Yii::createObject() 用于创建新的对象实例。您可以在创建新对象时使用此方法替换 new 运算符，这使您能够获得自动依赖项解析和默认属性配置的好处。

下面是使用 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);

有关 Container 的更多详细信息和使用信息，请参阅关于 di-containers 的指南文章。

公共属性

隐藏继承的属性

属性	类型	描述	定义于
$behaviors	yii\base\Behavior[]	附加到此组件的行为列表。	yii\base\Component
$definitions	array	对象定义或已加载的共享对象列表（类型或 ID => 定义或实例）。	yii\di\Container
$resolveArrays	boolean	是否尝试解析数组依赖项中的元素。	yii\di\Container
$singleton	string	类名、接口名或别名。	yii\di\Container
$singletons	array	单例定义的数组。	yii\di\Container

公共方法

隐藏继承的方法

方法	描述	定义于
__call()	调用不是类方法的命名方法。	yii\base\Component
__clone()	此方法在通过克隆现有对象创建对象后被调用。	yii\base\Component
__construct()	构造函数。	yii\base\BaseObject
__get()	返回组件属性的值。	yii\base\Component
__isset()	检查属性是否已设置，即已定义且不为 null。	yii\base\Component
__set()	设置组件属性的值。	yii\base\Component
__unset()	将组件属性设置为 null。	yii\base\Component
attachBehavior()	将行为附加到此组件。	yii\base\Component
attachBehaviors()	将行为列表附加到组件。	yii\base\Component
behaviors()	返回此组件应表现为的行为列表。	yii\base\Component
canGetProperty()	返回一个值，指示属性是否可以读取。	yii\base\Component
canSetProperty()	返回一个值，指示属性是否可以设置。	yii\base\Component
className()	返回此类的完全限定名称。	yii\base\BaseObject
clear()	删除指定名称的定义。	yii\di\Container
detachBehavior()	从组件中分离行为。	yii\base\Component
detachBehaviors()	从组件中分离所有行为。	yii\base\Component
ensureBehaviors()	确保在 behaviors() 中声明的行为已附加到此组件。	yii\base\Component
get()	返回请求类的实例。	yii\di\Container
getBehavior()	返回命名的行为对象。	yii\base\Component
getBehaviors()	返回附加到此组件的所有行为。	yii\base\Component
getDefinitions()	返回对象定义或已加载的共享对象的列表。	yii\di\Container
has()	返回一个值，指示容器是否具有指定名称的定义。	yii\di\Container
hasEventHandlers()	返回一个值，指示是否有任何处理程序附加到命名的事件。	yii\base\Component
hasMethod()	返回一个值，指示方法是否已定义。	yii\base\Component
hasProperty()	返回一个值，指示是否为此组件定义了属性。	yii\base\Component
hasSingleton()	返回一个值，指示给定名称是否对应于已注册的单例。	yii\di\Container
init()	初始化对象。	yii\base\BaseObject
invoke()	调用回调，并在参数中解析依赖项。	yii\di\Container
off()	从此组件中分离现有的事件处理程序。	yii\base\Component
on()	将事件处理程序附加到事件。	yii\base\Component
resolveCallableDependencies()	解析函数的依赖项。	yii\di\Container
set()	使用此容器注册类定义。	yii\di\Container
setDefinitions()	在此容器中注册类定义。	yii\di\Container
setResolveArrays()		yii\di\Container
setSingleton()	使用此容器注册类定义，并将类标记为单例类。	yii\di\Container
setSingletons()	通过调用 setSingleton() 将类定义注册为此容器中的单例。	yii\di\Container
trigger()	触发事件。	yii\base\Component

受保护的方法

隐藏继承的方法

方法	描述	定义于
build()	创建指定类的实例。	yii\di\Container
getDependencies()	返回指定类的依赖项。	yii\di\Container
mergeParams()	将用户指定的构造函数参数与通过 set() 注册的参数合并。	yii\di\Container
normalizeDefinition()	规范化类定义。	yii\di\Container
resolveDependencies()	通过将依赖项替换为实际的对象实例来解析依赖项。	yii\di\Container

属性详情

隐藏继承的属性

$definitions 公共属性

对象定义或已加载的共享对象列表（类型或 ID => 定义或实例）。

public array $definitions = null

$resolveArrays 公共属性

是否尝试解析数组依赖项中的元素。

public boolean $resolveArrays = null

$singleton 公共只写属性

类名、接口名或别名。

public $this setSingleton ( $class, $definition = [], array $params = [] )

$singletons public 只写属性 (自 2.0.11 版本起可用)

单例定义的数组。有关数组的允许格式，请参阅 setDefinitions()。

public void setSingletons ( array $singletons )

方法详情

隐藏继承的方法

__call() public 方法

定义于： yii\base\Component::__call()

调用不是类方法的命名方法。

此方法将检查任何附加的行为是否具有指定名称的方法，如果可用则执行它。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public mixed __call ( $name, $params )
$name	string	方法名称
$params	array	方法参数
返回值	mixed	方法的返回值
抛出异常	yii\base\UnknownMethodException	调用未知方法时

public void __construct ( $config = [] )
$config	array	将用于初始化对象属性的名称-值对

public mixed __get ( $name )
$name	string	属性名称
返回值	mixed	属性值或行为属性的值
抛出异常	yii\base\UnknownPropertyException	如果未定义属性
抛出异常	yii\base\InvalidCallException	如果属性为只写。

public boolean __isset ( $name )
$name	string	属性名称或事件名称
返回值	boolean	命名的属性是否已设置

public void __set ( $name, $value )
$name	string	属性名称或事件名称
$value	mixed	属性值
抛出异常	yii\base\UnknownPropertyException	如果未定义属性
抛出异常	yii\base\InvalidCallException	如果属性为只读。

public void __unset ( $name )
$name	string	属性名称
抛出异常	yii\base\InvalidCallException	如果属性为只读。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name	string	行为的名称。
$behavior	string\|array\|yii\base\Behavior	行为配置。可以是以下之一一个 yii\base\Behavior 对象指定行为类的字符串一个对象配置数组，它将传递给 Yii::createObject() 以创建行为对象。
返回值	yii\base\Behavior	行为对象

public void attachBehaviors ( $behaviors )
$behaviors	array	要附加到组件的行为列表

protected object build ( $class, $params, $config )
$class	string	类名
$params	array	构造函数参数
$config	array	要应用于新实例的配置
返回值	object	指定类的最新创建的实例
抛出异常	yii\di\NotInstantiableException	如果解析为抽象类或接口（自 2.0.9 起）

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
$checkBehaviors	boolean	是否将行为的属性视为此组件的属性
返回值	boolean	属性是否可读

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
$checkBehaviors	boolean	是否将行为的属性视为此组件的属性
返回值	boolean	属性是否可写

public boolean hasSingleton ( $class, $checkInstance = false )
$class	string	类名、接口名或别名。
$checkInstance	boolean	是否检查单例是否已实例化。
返回值	boolean	给定名称是否对应于已注册的单例。如果 `$checkInstance` 为 true，则该方法应返回值，指示单例是否已实例化。

public boolean off ( $name, $handler = null )
$name	string	事件名称
$handler	callable\|null	要删除的事件处理程序。如果为 null，则将删除附加到命名事件的所有处理程序。
返回值	boolean	如果找到并分离了处理程序

public void on ( $name, $handler, $data = null, $append = true )
$name	string	事件名称
$handler	callable	事件处理程序
$data	mixed	触发事件时要传递给事件处理程序的数据。当调用事件处理程序时，可以通过 yii\base\Event::$data 访问此数据。
$append	boolean	是否将新的事件处理程序追加到现有处理程序列表的末尾。如果为 false，则新的处理程序将插入到现有处理程序列表的开头。

protected array resolveDependencies ( $dependencies, $reflection = null )
$dependencies	array	依赖项
$reflection	ReflectionClass\|null	与依赖项关联的类反射
返回值	array	已解析的依赖项
抛出异常	yii\base\InvalidConfigException	如果无法解析依赖项或无法满足依赖项。

public static string className ( )
返回值	string	此类的完全限定名称。

public void clear ( $class )
$class	string	类名、接口名或别名。

public yii\base\Behavior\|null detachBehavior ( $name )
$name	string	行为的名称。
返回值	yii\base\Behavior\|null	分离的行为。如果行为不存在，则为 Null。

public object get ( $class, $params = [], $config = [] )
$class	string\|yii\di\Instance	类名、实例名或之前通过 set() 或 setSingleton() 注册的别名（例如 `foo`）。
$params	array	构造函数参数值的列表。使用以下两种定义之一参数作为键值对，例如：`['posts' => PostRepository::class]`。按构造函数声明中出现的顺序排列的参数。如果要跳过某些参数，则应使用表示它们在构造函数参数列表中的位置的整数对剩余的参数进行索引。不允许在同一个数组中使用名称和位置索引的依赖项。
$config	array	将用于初始化对象属性的键值对列表。
返回值	object	请求类的实例。
抛出异常	yii\base\InvalidConfigException	如果无法识别类或对应于无效的定义
抛出异常	yii\di\NotInstantiableException	如果解析为抽象类或接口（自 2.0.9 起）

public yii\base\Behavior\|null getBehavior ( $name )
$name	string	行为名称
返回值	yii\base\Behavior\|null	行为对象，如果行为不存在则为 null

public yii\base\Behavior[] getBehaviors ( )
返回值	yii\base\Behavior[]	附加到此组件的行为列表

public array getDefinitions ( )
返回值	array	对象定义或已加载的共享对象列表（类型或 ID => 定义或实例）。

protected array getDependencies ( $class )
$class	string	类名、接口名或别名。
返回值	array	指定类的依赖项。
抛出异常	yii\di\NotInstantiableException	如果无法解析依赖项或无法满足依赖项。

public boolean has ( $class )
$class	string	类名、接口名或别名。
返回值	boolean	容器是否具有指定名称的定义。

public boolean hasEventHandlers ( $name )
$name	string	事件名称
返回值	boolean	是否存在任何附加到事件的处理程序。

public boolean hasMethod ( $name, $checkBehaviors = true )
$name	string	属性名称
$checkBehaviors	boolean	是否将行为的方法视为此组件的方法
返回值	boolean	方法是否已定义

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	属性名称
$checkVars	boolean	是否将成员变量视为属性
$checkBehaviors	boolean	是否将行为的属性视为此组件的属性
返回值	boolean	属性是否已定义

public mixed invoke ( callable $callback, $params = [] )
$callback	callable	要调用的可调用对象。
$params	array	函数的参数数组。这可以是一个参数列表，也可以是一个关联数组，表示命名函数参数。
返回值	mixed	回调返回值。
抛出异常	yii\base\InvalidConfigException	如果无法解析依赖项或无法满足依赖项。
抛出异常	yii\di\NotInstantiableException	如果解析为抽象类或接口（自 2.0.9 起）

protected array mergeParams ( $class, $params )
$class	string	类名、接口名或别名。
$params	array	构造函数参数
返回值	array	合并后的参数

protected array normalizeDefinition ( $class, $definition )
$class	string	类名
$definition	string\|array\|callable	类定义
返回值	array	标准化的类定义
抛出异常	yii\base\InvalidConfigException	如果定义无效。

public array resolveCallableDependencies ( callable $callback, $params = [] )
$callback	callable	要调用的可调用对象。
$params	array	函数的参数数组，可以是数字的或关联的。
返回值	array	已解析的依赖项。
抛出异常	yii\base\InvalidConfigException	如果无法解析依赖项或无法满足依赖项。
抛出异常	yii\di\NotInstantiableException	如果解析为抽象类或接口（自 2.0.9 起）

public $this set ( $class, $definition = [], array $params = [] )
$class	string	类名、接口名或别名。
$definition	mixed	与`$class`关联的定义。它可以是以下之一 PHP 可调用对象：调用 get() 时将执行此可调用对象。可调用对象的签名应为`function ($container, $params, $config)`，其中`$params`代表构造函数参数列表，`$config`代表对象配置，`$container`代表容器对象。可调用对象的返回值将由 get() 返回作为请求的对象实例。配置数组：该数组包含用于在调用 get() 时初始化新创建对象属性值的名称-值对。`class`元素代表要创建的对象的类。如果未指定`class`，则`$class`将用作类名。字符串：类名、接口名或别名。
$params	array	构造函数参数列表。调用 get() 时，这些参数将传递给类构造函数。
返回值	$this	容器本身

public void setDefinitions ( array $definitions )
$definitions	array	定义数组。数组有两种允许的格式。第一种格式键：类名、接口名或别名。该键将作为第一个参数`$class`传递给 set() 方法。值：与`$class`关联的定义。可能的值在 set() 文档中针对`$definition`参数进行了描述。将作为第二个参数`$definition`传递给 set() 方法。示例：`php $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); }` ]); ` 第二种格式键：类名、接口名或别名。该键将作为第一个参数`$class`传递给 set() 方法。值：包含两个元素的数组。第一个元素将作为第二个参数`$definition`传递给 set() 方法，第二个元素作为`$params`传递。示例：`php $container->setDefinitions([ `'foo\Bar' => [ ['class' => 'app\Bar'], [Instance::of('baz')] ]` ]); `

public void setResolveArrays ( $value )
$value	boolean	是否尝试解析数组依赖项中的元素

public void trigger ( $name, yii\base\Event $event = null )
$name	string	事件名称
$event	yii\base\Event\|null	事件实例。如果未设置，则会创建一个默认的 yii\base\Event 对象。