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 公共唯寫屬性 (自版本 2.0.11 起可用)

單例定義的陣列。有關陣列的允許格式，請參閱 setDefinitions()。

public void setSingletons ( array $singletons )

方法詳細資訊

隱藏繼承的方法

__call() 公共方法

定義於： yii\base\Component::__call()

呼叫不是類別方法的具名方法。

此方法將檢查是否有任何附加的行為具有具名方法，並在可用的情況下執行它。

請勿直接呼叫此方法，因為它是 PHP 魔術方法，當呼叫未知方法時會隱式呼叫它。

public mixed __call ( $name, $params )
$name	string	方法名稱
$params	array	方法參數
return	mixed	方法傳回值
throws	yii\base\UnknownMethodException	當呼叫未知方法時

public void __construct ( $config = [] )
$config	array	將用於初始化物件屬性的名稱-值對

public mixed __get ( $name )
$name	string	屬性名稱
return	mixed	屬性值或行為的屬性值
throws	yii\base\UnknownPropertyException	如果未定義屬性
throws	yii\base\InvalidCallException	如果屬性為唯寫。

public boolean __isset ( $name )
$name	string	屬性名稱或事件名稱
return	boolean	具名屬性是否已設定

public void __set ( $name, $value )
$name	string	屬性名稱或事件名稱
$value	mixed	屬性值
throws	yii\base\UnknownPropertyException	如果未定義屬性
throws	yii\base\InvalidCallException	如果屬性為唯讀。

public void __unset ( $name )
$name	string	屬性名稱
throws	yii\base\InvalidCallException	如果屬性為唯讀。

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name	string	行為的名稱。
$behavior	string\|array\|yii\base\Behavior	行為設定。這可以是下列其中一項 yii\base\Behavior 物件指定行為類別的字串將傳遞給 Yii::createObject() 以建立行為物件的物件設定陣列。
return	yii\base\Behavior	行為物件

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

protected object build ( $class, $params, $config )
$class	string	類別名稱
$params	array	建構子參數
$config	array	要應用於新實例的設定
return	object	指定類別的新建立實例
throws	yii\di\NotInstantiableException	如果解析為抽象類別或介面 (自 2.0.9 起)

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
$checkBehaviors	boolean	是否將行為的屬性視為此組件的屬性
return	boolean	屬性是否可讀取

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
$checkBehaviors	boolean	是否將行為的屬性視為此組件的屬性
return	boolean	屬性是否可寫入

public boolean hasSingleton ( $class, $checkInstance = false )
$class	string	類別名稱、介面名稱或別名
$checkInstance	boolean	是否檢查單例是否已被實例化。
return	boolean	給定名稱是否對應於已註冊的單例。如果 `$checkInstance` 為 true，則此方法應傳回一個值，指示單例是否已被實例化。

public boolean off ( $name, $handler = null )
$name	string	事件名稱
$handler	callable\|null	要移除的事件處理器。如果為 null，則會移除附加到具名事件的所有處理器。
return	boolean	如果找到並分離處理器

public void on ( $name, $handler, $data = null, $append = true )
$name	string	事件名稱
$handler	可調用項	事件處理器
$data	mixed	事件觸發時要傳遞給事件處理器的資料。調用事件處理器時，可以透過 yii\base\Event::$data 存取此資料。
$append	boolean	是否將新的事件處理器附加到現有處理器列表的末尾。如果為 false，則新處理器將插入到現有處理器列表的開頭。

protected array resolveDependencies ( $dependencies, $reflection = null )
$dependencies	array	依賴項
$reflection	ReflectionClass\|null	與依賴項關聯的類別反射
return	array	已解析的依賴項
throws	yii\base\InvalidConfigException	如果依賴項無法解析或依賴項無法滿足時。

public static string className ( )
return	string	此類別的完整限定名稱。

public void clear ( $class )
$class	string	類別名稱、介面名稱或別名

public yii\base\Behavior\|null detachBehavior ( $name )
$name	string	行為的名稱。
return	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	將用於初始化物件屬性的名稱-值對列表。
return	object	請求類別的實例。
throws	yii\base\InvalidConfigException	如果類別無法識別或對應於無效的定義
throws	yii\di\NotInstantiableException	如果解析為抽象類別或介面 (自 2.0.9 起)

public yii\base\Behavior\|null getBehavior ( $name )
$name	string	行為名稱
return	yii\base\Behavior\|null	行為物件，如果行為不存在則為 null

public yii\base\Behavior[] getBehaviors ( )
return	yii\base\Behavior[]	附加到此元件的行為列表

public array getDefinitions ( )
return	array	物件定義或已載入的共享物件列表 (類型或 ID => 定義或實例)。

protected array getDependencies ( $class )
$class	string	類別名稱、介面名稱或別名
return	array	指定類別的依賴項。
throws	yii\di\NotInstantiableException	如果依賴項無法解析或依賴項無法滿足時。

public boolean has ( $class )
$class	string	類別名稱、介面名稱或別名
return	boolean	容器是否具有指定名稱的定義。

public boolean hasEventHandlers ( $name )
$name	string	事件名稱
return	boolean	是否有任何處理器附加到事件。

public boolean hasMethod ( $name, $checkBehaviors = true )
$name	string	屬性名稱
$checkBehaviors	boolean	是否將行為的方法視為此元件的方法
return	boolean	方法是否已定義

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name	string	屬性名稱
$checkVars	boolean	是否將成員變數視為屬性
$checkBehaviors	boolean	是否將行為的屬性視為此組件的屬性
return	boolean	屬性是否已定義

public mixed invoke ( callable $callback, $params = [] )
$callback	可調用項	要調用的可調用項。
$params	array	函數的參數陣列。這可以是參數列表，也可以是表示具名函數參數的關聯陣列。
return	mixed	回呼函數的傳回值。
throws	yii\base\InvalidConfigException	如果依賴項無法解析或依賴項無法滿足時。
throws	yii\di\NotInstantiableException	如果解析為抽象類別或介面 (自 2.0.9 起)

protected array mergeParams ( $class, $params )
$class	string	類別名稱、介面名稱或別名
$params	array	建構函式參數
return	array	合併後的參數

protected array normalizeDefinition ( $class, $definition )
$class	string	類別名稱
$definition	string\|array\|callable	類別定義
return	array	標準化的類別定義
throws	yii\base\InvalidConfigException	如果定義無效。

public array resolveCallableDependencies ( callable $callback, $params = [] )
$callback	可調用項	要調用的可調用項。
$params	array	函數的參數陣列，可以是數值或關聯陣列。
return	array	已解析的依賴項。
throws	yii\base\InvalidConfigException	如果依賴項無法解析或依賴項無法滿足時。
throws	yii\di\NotInstantiableException	如果解析為抽象類別或介面 (自 2.0.9 起)

public 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() 時，參數將傳遞給類別建構函式。
return	$this	容器本身

public void setDefinitions ( array $definitions )
$definitions	array	定義陣列。陣列有兩種允許的格式。第一種格式 key：類別名稱、介面名稱或別名。索引鍵將作為第一個參數 `$class` 傳遞給 set() 方法。 value：與 `$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); }` ]); ` 第二種格式 key：類別名稱、介面名稱或別名。索引鍵將作為第一個參數 `$class` 傳遞給 set() 方法。 value：包含兩個元素的陣列。第一個元素將作為第二個參數 `$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 物件。