0 追蹤者

抽象類別 yii\test\BaseActiveFixture

繼承關係yii\test\BaseActiveFixture » yii\test\DbFixture » yii\test\Fixture » yii\base\Component » yii\base\BaseObject
實作介面ArrayAccess, Countable, IteratorAggregate, yii\base\Configurable
使用 Traitsyii\base\ArrayAccessTrait, yii\test\FileFixtureTrait
子類別yii\test\ActiveFixture
自版本起可用2.0
原始碼 https://github.com/yiisoft/yii2/blob/master/framework/test/BaseActiveFixture.php

BaseActiveFixture 是 fixture 類別的基礎類別,支援以 ActiveRecord 物件存取 fixture 資料。

關於 BaseActiveFixture 的更多詳細資訊和使用方式,請參閱關於 fixture 的指南文章

公開屬性

隱藏繼承的屬性

屬性 類型 描述 定義於
$behaviors yii\base\Behavior[] 附加到此元件的行為列表。 yii\base\Component
$data array 資料列。 yii\test\BaseActiveFixture
$dataDirectory string 包含 fixture 資料的目錄路徑或 路徑別名 yii\test\FileFixtureTrait
$dataFile string|boolean 資料檔案的路徑或 路徑別名,其中包含要由 getData() 傳回的 fixture 資料。 yii\test\FileFixtureTrait
$db yii\db\Connection|array|string DB 連線物件或 DB 連線的應用程式元件 ID。 yii\test\DbFixture
$depends array 此 fixture 相依的 fixtures。 yii\test\Fixture
$iterator ArrayIterator 用於遍歷集合中 cookies 的迭代器。 yii\base\ArrayAccessTrait
$modelClass string 與此 fixture 關聯的 AR 模型類別。 yii\test\BaseActiveFixture

公開方法

隱藏繼承的方法

方法 描述 定義於
__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
afterLoad() 此方法會在目前測試的所有 fixture 資料載入「之後」呼叫。 yii\test\Fixture
afterUnload() 此方法會在目前測試的所有 fixture 資料卸載「之後」呼叫。 yii\test\Fixture
attachBehavior() 將行為附加到此元件。 yii\base\Component
attachBehaviors() 將行為列表附加到此元件。 yii\base\Component
beforeLoad() 此方法會在目前測試的任何 fixture 資料載入「之前」呼叫。 yii\test\Fixture
beforeUnload() 此方法會在目前測試的任何 fixture 資料卸載「之前」呼叫。 yii\test\Fixture
behaviors() 傳回此元件應表現為哪些行為的列表。 yii\base\Component
canGetProperty() 傳回一個值,指示是否可以讀取屬性。 yii\base\Component
canSetProperty() 傳回一個值,指示是否可以設定屬性。 yii\base\Component
className() 傳回此類別的完整限定名稱。 yii\base\BaseObject
count() 傳回資料項目的數量。 yii\base\ArrayAccessTrait
detachBehavior() 從元件中分離行為。 yii\base\Component
detachBehaviors() 從元件中分離所有行為。 yii\base\Component
ensureBehaviors() 確保在 behaviors() 中宣告的行為已附加到此元件。 yii\base\Component
getBehavior() 傳回具名的行為物件。 yii\base\Component
getBehaviors() 傳回附加到此元件的所有行為。 yii\base\Component
getIterator() 傳回用於遍歷資料的迭代器。 yii\base\ArrayAccessTrait
getModel() 依指定的模型名稱傳回 AR 模型。 yii\test\BaseActiveFixture
hasEventHandlers() 傳回一個值,指示是否有任何處理常式附加到具名事件。 yii\base\Component
hasMethod() 傳回一個值,指示是否已定義方法。 yii\base\Component
hasProperty() 傳回一個值,指示是否已為此元件定義屬性。 yii\base\Component
init() 初始化物件。 yii\test\DbFixture
load() 載入 fixture。 yii\test\BaseActiveFixture
off() 從此元件分離現有的事件處理常式。 yii\base\Component
offsetExists() 此方法為介面 ArrayAccess 所需。 yii\base\ArrayAccessTrait
offsetGet() 此方法為介面 ArrayAccess 所需。 yii\base\ArrayAccessTrait
offsetSet() 此方法為介面 ArrayAccess 所需。 yii\base\ArrayAccessTrait
offsetUnset() 此方法為介面 ArrayAccess 所需。 yii\base\ArrayAccessTrait
on() 將事件處理常式附加到事件。 yii\base\Component
trigger() 觸發事件。 yii\base\Component
unload() 卸載 fixture。 yii\test\BaseActiveFixture

受保護的方法

隱藏繼承的方法

方法 描述 定義於
getData() 傳回 fixture 資料。 yii\test\BaseActiveFixture
loadData() 傳回 fixture 資料。 yii\test\FileFixtureTrait

屬性詳細資訊

隱藏繼承的屬性

$data 公用屬性

資料列。每個陣列元素代表一列資料 (欄位名稱 => 欄位值)。

public array $data = []
$modelClass 公用屬性

與此 fixture 關聯的 AR 模型類別。

public string $modelClass null

方法詳細資訊

隱藏繼承的方法

__call() 公用方法

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

呼叫指定的非類別方法。

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

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在呼叫未知方法時隱式呼叫。

public mixed __call ( $name, $params )
$name string

方法名稱

$params array

方法參數

return mixed

方法傳回值

throws yii\base\UnknownMethodException

當呼叫未知方法時

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() 公用方法

定義於: yii\base\Component::__clone()

在透過複製現有物件建立物件後,會呼叫此方法。

它會移除所有行為,因為這些行為都附加到舊的物件。

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() 公用方法

定義於: yii\base\BaseObject::__construct()

建構子。

預設實作會執行兩件事

  • 使用給定的組態 $config 初始化物件。
  • 呼叫 init()

如果子類別中覆寫了此方法,建議

  • 建構子的最後一個參數是組態陣列,例如此處的 $config
  • 在建構子的結尾呼叫父類別實作。
public void __construct ( $config = [] )
$config array

將用於初始化物件屬性的名稱-值配對

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() 公用方法

定義於: yii\base\Component::__get()

傳回元件屬性的值。

此方法將依以下順序檢查並據此執行動作

  • getter 定義的屬性:傳回 getter 結果
  • 行為的屬性:傳回行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 $value = $component->property; 時隱式呼叫。

另請參閱 __set()

public mixed __get ( $name )
$name string

屬性名稱

return mixed

屬性值或行為屬性的值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯寫。

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() 公用方法

定義於: yii\base\Component::__isset()

檢查屬性是否已設定,即已定義且非 null。

此方法將依以下順序檢查並據此執行動作

  • setter 定義的屬性:傳回屬性是否已設定
  • 行為的屬性:傳回屬性是否已設定
  • 針對不存在的屬性傳回 false

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 isset($component->property) 時隱式呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.isset.php

public boolean __isset ( $name )
$name string

屬性名稱或事件名稱

return boolean

具名屬性是否已設定

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() 公用方法

定義於: yii\base\Component::__set()

設定元件屬性的值。

此方法將依以下順序檢查並據此執行動作

  • setter 定義的屬性:設定屬性值
  • 格式為 "on xyz" 的事件:將處理常式附加到事件 "xyz"
  • 格式為 "as xyz" 的行為:附加名為 "xyz" 的行為
  • 行為的屬性:設定行為屬性值

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 $component->property = $value; 時隱式呼叫。

另請參閱 __get()

public void __set ( $name, $value )
$name string

屬性名稱或事件名稱

$value mixed

屬性值

throws yii\base\UnknownPropertyException

如果未定義屬性

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() 公用方法

定義於: yii\base\Component::__unset()

將元件屬性設定為 null。

此方法將依以下順序檢查並據此執行動作

  • setter 定義的屬性:將屬性值設定為 null
  • 行為的屬性:將屬性值設定為 null

請勿直接呼叫此方法,因為它是 PHP 魔術方法,將在執行 unset($component->property) 時隱式呼叫。

另請參閱 https://php.dev.org.tw/manual/en/function.unset.php

public void __unset ( $name )
$name string

屬性名稱

throws yii\base\InvalidCallException

如果屬性為唯讀。

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterLoad() 公用方法

定義於: yii\test\Fixture::afterLoad()

此方法會在目前測試的所有 fixture 資料載入「之後」呼叫。

public void afterLoad ( )

                public function afterLoad()
{
}

            
afterUnload() 公用方法

定義於: yii\test\Fixture::afterUnload()

此方法會在目前測試的所有 fixture 資料卸載「之後」呼叫。

public void afterUnload ( )

                public function afterUnload()
{
}

            
attachBehavior() 公用方法

定義於: yii\base\Component::attachBehavior()

將行為附加到此元件。

此方法將根據給定的組態建立行為物件。之後,將透過呼叫 yii\base\Behavior::attach() 方法將行為物件附加到此元件。

另請參閱 detachBehavior()

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

行為的名稱。

$behavior string|array|yii\base\Behavior

行為組態。這可以是下列其中一項

return yii\base\Behavior

行為物件

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() 公用方法

定義於: yii\base\Component::attachBehaviors()

將行為列表附加到此元件。

每個行為都依其名稱編製索引,且應為 yii\base\Behavior 物件、指定行為類別的字串,或是用於建立行為的組態陣列。

另請參閱 attachBehavior()

public void attachBehaviors ( $behaviors )
$behaviors array

要附加到元件的行為列表

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeLoad() 公用方法

定義於: yii\test\Fixture::beforeLoad()

此方法會在目前測試的任何 fixture 資料載入「之前」呼叫。

public void beforeLoad ( )

                public function beforeLoad()
{
}

            
beforeUnload() 公用方法

定義於: yii\test\Fixture::beforeUnload()

此方法會在目前測試的任何 fixture 資料卸載「之前」呼叫。

public void beforeUnload ( )

                public function beforeUnload()
{
}

            
behaviors() 公用方法

定義於: yii\base\Component::behaviors()

傳回此元件應表現為哪些行為的列表。

子類別可以覆寫此方法,以指定它們想要表現為哪些行為。

此方法的傳回值應為行為物件或組態的陣列,並依行為名稱編製索引。行為組態可以是指定行為類別的字串,或是以下結構的陣列

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

請注意,行為類別必須從 yii\base\Behavior 擴充。可以使用名稱或匿名方式附加行為。當使用名稱作為陣列索引鍵時,使用此名稱,稍後可以使用 getBehavior() 擷取行為,或使用 detachBehavior() 分離行為。匿名行為無法擷取或分離。

在此方法中宣告的行為將自動 (依需求) 附加到元件。

public array behaviors ( )
return array

行為組態。

                public function behaviors()
{
    return [];
}

            
canGetProperty() 公用方法

定義於: yii\base\Component::canGetProperty()

傳回一個值,指示是否可以讀取屬性。

如果符合下列條件,則可以讀取屬性

  • 類別具有與指定名稱相關聯的 getter 方法 (在此情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可讀屬性 (當 $checkBehaviors 為 true 時)。

另請參閱 canSetProperty()

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

是否可以讀取屬性

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() 公用方法

定義於: yii\base\Component::canSetProperty()

傳回一個值,指示是否可以設定屬性。

如果符合下列條件,則可以寫入屬性

  • 類別具有與指定名稱相關聯的 setter 方法 (在此情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的可寫入屬性 (當 $checkBehaviors 為 true 時)。

另請參閱 canGetProperty()

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

是否可以寫入屬性

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() 公用靜態方法
自 2.0.14 版起已棄用。在 PHP >=5.5 上,請改用 ::class

定義於: yii\base\BaseObject::className()

傳回此類別的完整限定名稱。

public static string className ( )
return string

此類別的完整限定名稱。

                public static function className()
{
    return get_called_class();
}

            
count() 公用方法

定義於: yii\base\ArrayAccessTrait::count()

傳回資料項目的數量。

此方法為 Countable 介面所需。

public integer count ( )
return integer

資料元素的數量。

                #[\ReturnTypeWillChange]
public function count()
{
    return count($this->data);
}

            
detachBehavior() 公用方法

定義於: yii\base\Component::detachBehavior()

從元件中分離行為。

將會叫用行為的 yii\base\Behavior::detach() 方法。

public yii\base\Behavior|null detachBehavior ( $name )
$name string

行為的名稱。

return yii\base\Behavior|null

已分離的行為。如果行為不存在,則為 Null。

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() 公用方法

定義於: yii\base\Component::detachBehaviors()

從元件中分離所有行為。

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() 公用方法

定義於: yii\base\Component::ensureBehaviors()

確保在 behaviors() 中宣告的行為已附加到此元件。

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() 公用方法

定義於: yii\base\Component::getBehavior()

傳回具名的行為物件。

public yii\base\Behavior|null getBehavior ( $name )
$name string

行為名稱

return yii\base\Behavior|null

行為物件,如果行為不存在則為 null

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() 公用方法

定義於: yii\base\Component::getBehaviors()

傳回附加到此元件的所有行為。

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

附加到此元件的行為列表

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getData() 受保護的方法

傳回 fixture 資料。

另請參閱 loadData()

protected array getData ( )
return array

要放入資料庫的資料

throws yii\base\InvalidConfigException

如果指定的資料檔案不存在。

                protected function getData()
{
    return $this->loadData($this->dataFile);
}

            
getIterator() 公用方法

定義於: yii\base\ArrayAccessTrait::getIterator()

傳回用於遍歷資料的迭代器。

此方法為 SPL 介面 IteratorAggregate 所需。當您使用 foreach 遍歷集合時,將隱式呼叫此方法。

public ArrayIterator getIterator ( )
return ArrayIterator

用於遍歷集合中 cookies 的迭代器。

                #[\ReturnTypeWillChange]
public function getIterator()
{
    return new \ArrayIterator($this->data);
}

            
getModel() public method

依指定的模型名稱傳回 AR 模型。

模型名稱是 $data 中對應資料列的鍵值。

public yii\db\ActiveRecord|null getModel ( $name )
$name string

模型名稱。

return yii\db\ActiveRecord|null

AR 模型,如果模型在資料庫中找不到則為 null

throws yii\base\InvalidConfigException

如果 $modelClass 未設定。

                public function getModel($name)
{
    if (!isset($this->data[$name])) {
        return null;
    }
    if (array_key_exists($name, $this->_models)) {
        return $this->_models[$name];
    }
    if ($this->modelClass === null) {
        throw new InvalidConfigException('The "modelClass" property must be set.');
    }
    $row = $this->data[$name];
    /* @var $modelClass \yii\db\ActiveRecord */
    $modelClass = $this->modelClass;
    $keys = [];
    foreach ($modelClass::primaryKey() as $key) {
        $keys[$key] = isset($row[$key]) ? $row[$key] : null;
    }
    return $this->_models[$name] = $modelClass::findOne($keys);
}

            
hasEventHandlers() public method

定義於: yii\base\Component::hasEventHandlers()

傳回一個值,指示是否有任何處理常式附加到具名事件。

public boolean hasEventHandlers ( $name )
$name string

事件名稱

return boolean

是否有任何處理器附加到此事件。

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

定義於: yii\base\Component::hasMethod()

傳回一個值,指示是否已定義方法。

如果滿足以下條件,則定義了方法

  • 類別具有指定名稱的方法
  • 附加的行為具有給定名稱的方法(當 $checkBehaviors 為 true 時)。
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

屬性名稱

$checkBehaviors boolean

是否將行為的方法視為此組件的方法

return boolean

方法是否已定義

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

定義於: yii\base\Component::hasProperty()

傳回一個值,指示是否已為此元件定義屬性。

如果滿足以下條件,則定義了屬性

  • 類別具有與指定名稱相關聯的 getter 或 setter 方法(在這種情況下,屬性名稱不區分大小寫);
  • 類別具有具有指定名稱的成員變數 (當 $checkVars 為 true 時);
  • 附加的行為具有給定名稱的屬性(當 $checkBehaviors 為 true 時)。

另請參閱

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

屬性名稱

$checkVars boolean

是否將成員變數視為屬性

$checkBehaviors boolean

是否將行為的屬性視為此元件的屬性

return boolean

屬性是否已定義

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

定義於: yii\test\DbFixture::init()

初始化物件。

在物件使用給定配置初始化後,此方法會在建構函式的結尾被調用。

public void init ( )

                public function init()
{
    parent::init();
    $this->db = Instance::ensure($this->db, BaseObject::className());
}

            
load() public method

載入 fixture。

預設實作僅將 getData() 返回的資料儲存在 $data 中。您通常應該覆寫此方法,將資料放入底層資料庫中。

public void load ( )

                public function load()
{
    $this->data = $this->getData();
}

            
loadData() protected method

定義於: yii\test\FileFixtureTrait::loadData()

傳回 fixture 資料。

預設實作將嘗試通過包含 $dataFile 指定的外部檔案來返回測試夾具資料。該檔案應返回資料陣列,該陣列將在插入資料庫後儲存在 data 中。

protected array loadData ( $file, $throwException true )
$file string

資料檔案路徑

$throwException boolean

如果測試夾具資料檔案不存在是否拋出例外。

return array

要放入資料庫的資料

throws yii\base\InvalidConfigException

如果指定的資料檔案不存在。

                protected function loadData($file, $throwException = true)
{
    if ($file === null || $file === false) {
        return [];
    }
    if (basename($file) === $file && $this->dataDirectory !== null) {
        $file = $this->dataDirectory . '/' . $file;
    }
    $file = Yii::getAlias($file);
    if (is_file($file)) {
        return require $file;
    }
    if ($throwException) {
        throw new InvalidConfigException("Fixture data file does not exist: {$file}");
    }
    return [];
}

            
off() public method

定義於: yii\base\Component::off()

從此元件分離現有的事件處理常式。

此方法與 on() 相反。

注意:如果為事件名稱傳遞了萬用字元模式,則只會移除使用此萬用字元註冊的處理器,而使用與此萬用字元匹配的純名稱註冊的處理器將保留。

另請參閱 on()

public boolean off ( $name, $handler null )
$name string

事件名稱

$handler callable|null

要移除的事件處理器。如果為 null,則會移除附加到命名事件的所有處理器。

return boolean

如果找到並分離了處理器

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
offsetExists() public method

定義於: yii\base\ArrayAccessTrait::offsetExists()

此方法為介面 ArrayAccess 所需。

public boolean offsetExists ( $offset )
$offset mixed

要檢查的索引

                #[\ReturnTypeWillChange]
public function offsetExists($offset)
{
    return isset($this->data[$offset]);
}

            
offsetGet() public method

定義於: yii\base\ArrayAccessTrait::offsetGet()

此方法為介面 ArrayAccess 所需。

public mixed offsetGet ( $offset )
$offset integer

要檢索元素的索引。

return mixed

索引處的元素;如果在索引處未找到元素,則為 null

                #[\ReturnTypeWillChange]
public function offsetGet($offset)
{
    return isset($this->data[$offset]) ? $this->data[$offset] : null;
}

            
offsetSet() public method

定義於: yii\base\ArrayAccessTrait::offsetSet()

此方法為介面 ArrayAccess 所需。

public void offsetSet ( $offset, $item )
$offset integer

要設定元素的索引

$item mixed

元素值

                #[\ReturnTypeWillChange]
public function offsetSet($offset, $item)
{
    $this->data[$offset] = $item;
}

            
offsetUnset() public method

定義於: yii\base\ArrayAccessTrait::offsetUnset()

此方法為介面 ArrayAccess 所需。

public void offsetUnset ( $offset )
$offset mixed

要取消設定元素的索引

                #[\ReturnTypeWillChange]
public function offsetUnset($offset)
{
    unset($this->data[$offset]);
}

            
on() public method

定義於: yii\base\Component::on()

將事件處理常式附加到事件。

事件處理器必須是有效的 PHP 回呼。以下是一些範例

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

事件處理器必須使用以下簽名定義:

function ($event)

其中 $event 是一個 yii\base\Event 物件,其中包含與事件相關聯的參數。

自 2.0.14 版本起,您可以將事件名稱指定為萬用字元模式

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

另請參閱 off()

public void on ( $name, $handler, $data null, $append true )
$name string

事件名稱

$handler 可呼叫 (callable)

事件處理器

$data mixed

事件觸發時要傳遞給事件處理器的資料。當調用事件處理器時,可以通過 yii\base\Event::$data 訪問此資料。

$append boolean

是否將新的事件處理器附加到現有處理器列表的末尾。如果為 false,則新處理器將插入到現有處理器列表的開頭。

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
trigger() public method

定義於: yii\base\Component::trigger()

觸發事件。

此方法表示事件的發生。它調用事件的所有附加處理器,包括類別級別的處理器。

public void trigger ( $name, yii\base\Event $event null )
$name string

事件名稱

$event yii\base\Event|null

事件實例。如果未設定,將創建預設的 yii\base\Event 物件。

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
unload() public method

卸載 fixture。

此方法在每個測試方法完成後調用。您可以覆寫此方法,以執行測試夾具的必要清理工作。

public void unload ( )

                public function unload()
{
    parent::unload();
    $this->data = [];
    $this->_models = [];
}