クラス yii\test\InitDbFixture
InitDbFixture は、DB 関連のテストに必要な初期状態を表します。
その主な役割は、データ読み込み中のデータベースの整合性チェックを切り替えることです。これは、他の DB 関連のフィクスチャ（例：yii\test\ActiveFixture）が整合性チェックエラーを発生させることなくデータベースにデータを追加できるようにするために必要です。
さらに、DbFixture は、存在する場合は初期化スクリプトの読み込みも試みます。
通常、InitDbFixture を使用して、スケルトンのテストデータベースを準備する必要があります。その後、他の DB フィクスチャがこのデータベースに特定のテーブルとデータを追加します。
InitDbFixture の詳細と使用方法については、フィクスチャに関するガイド記事を参照してください。
公開プロパティ
| プロパティ | 型 | 説明 | 定義元 |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | このコンポーネントにアタッチされているビヘイビアのリスト。 | yii\base\Component |
| $db | yii\db\Connection|配列|文字列 | DB 接続オブジェクト、または DB 接続のアプリケーションコンポーネント ID。 | yii\test\DbFixture |
| $depends | 配列 | このフィクスチャが依存するフィクスチャ。 | yii\test\Fixture |
| $initScript | 文字列 | このフィクスチャの読み込み時に実行される初期化スクリプトファイル。 | yii\test\InitDbFixture |
| $schemas | 配列 | テストテーブルが存在する可能性のあるデータベーススキーマのリスト。 | yii\test\InitDbFixture |
公開メソッド
| メソッド | 説明 | 定義元 |
|---|---|---|
| __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() | このメソッドは、現在のテストに対してすべてのフィクスチャデータが読み込まれた後に呼び出されます。 | yii\test\InitDbFixture |
| afterUnload() | このメソッドは、現在のテストに対してすべてのフィクスチャデータがアンロードされた後に呼び出されます。 | yii\test\InitDbFixture |
| attachBehavior() | このコンポーネントにビヘイビアをアタッチします。 | yii\base\Component |
| attachBehaviors() | コンポーネントにビヘイビアのリストをアタッチします。 | yii\base\Component |
| beforeLoad() | このメソッドは、現在のテストに対してフィクスチャデータが読み込まれる前に呼び出されます。 | yii\test\InitDbFixture |
| beforeUnload() | このメソッドは、現在のテストに対してフィクスチャデータがアンロードされる前に呼び出されます。 | yii\test\InitDbFixture |
| behaviors() | このコンポーネントがビヘイビアとして動作する必要があるビヘイビアのリストを返します。 | yii\base\Component |
| canGetProperty() | プロパティを読み取ることができるかどうかを示す値を返します。 | yii\base\Component |
| canSetProperty() | プロパティを設定できるかどうかを示す値を返します。 | yii\base\Component |
| checkIntegrity() | DB の整合性チェックを切り替えます。 | yii\test\InitDbFixture |
| className() | このクラスの完全修飾名を返します。 | yii\base\BaseObject |
| detachBehavior() | コンポーネントからビヘイビアをデタッチします。 | yii\base\Component |
| detachBehaviors() | コンポーネントからすべてのビヘイビアをデタッチします。 | yii\base\Component |
| ensureBehaviors() | behaviors()で宣言されたビヘイビアがこのコンポーネントにアタッチされていることを確認します。 | yii\base\Component |
| getBehavior() | 名前付きビヘイビアオブジェクトを返します。 | yii\base\Component |
| getBehaviors() | このコンポーネントにアタッチされているすべてのビヘイビアを返します。 | yii\base\Component |
| hasEventHandlers() | 名前付きイベントにハンドラーがアタッチされているかどうかを示す値を返します。 | yii\base\Component |
| hasMethod() | メソッドが定義されているかどうかを示す値を返します。 | yii\base\Component |
| hasProperty() | このコンポーネントのプロパティが定義されているかどうかを示す値を返します。 | yii\base\Component |
| init() | オブジェクトを初期化します。 | yii\test\DbFixture |
| load() | フィクスチャを読み込みます。 | yii\test\InitDbFixture |
| off() | このコンポーネントから既存のイベントハンドラーをデタッチします。 | yii\base\Component |
| on() | イベントにイベントハンドラーをアタッチします。 | yii\base\Component |
| trigger() | イベントをトリガーします。 | yii\base\Component |
| unload() | フィクスチャをアンロードします。 | yii\test\Fixture |
プロパティの詳細
このフィクスチャのロード時に実行されるinitスクリプトファイル。ファイルパス、またはパスエイリアスを指定する必要があります。ファイルが存在しない場合、エラーは発生しません。
メソッドの詳細
定義されている場所: yii\base\Component::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、アタッチされたビヘイビアに指定されたメソッドがあるかどうかをチェックし、存在する場合は実行します。
これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。
| public mixed __call ( $name, $params ) | ||
| $name | 文字列 |
メソッド名 |
| $params | 配列 |
メソッドパラメータ |
| 戻り値 | mixed |
メソッドの戻り値 |
|---|---|---|
| 例外 | 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()");
}
定義されている場所: yii\base\Component::__clone()
このメソッドは、既存のオブジェクトを複製してオブジェクトが作成された後に呼び出されます。
ビヘイビアは古いオブジェクトにアタッチされているため、すべてのビヘイビアを削除します。
| public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
定義されている場所: yii\base\BaseObject::__construct()
コンストラクタ。
デフォルトの実装では、次の2つのことを行います。
- 指定された設定
$configを使用してオブジェクトを初期化します。 - init()を呼び出します。
このメソッドを子クラスでオーバーライドする場合は、
- コンストラクタの最後の引数が、ここにある
$configのような設定配列であることをお勧めします。 - コンストラクタの最後に親の実装を呼び出してください。
| public void __construct ( $config = [] ) | ||
| $config | 配列 |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義されている場所: yii\base\Component::__get()
コンポーネントプロパティの値を返します。
このメソッドは、以下の順序でチェックし、それに応じて動作します。
- ゲッターで定義されたプロパティ：ゲッターの結果を返す
- ビヘイビアのプロパティ：ビヘイビアのプロパティ値を返す
これはPHPのマジックメソッドであり、$value = $component->property;を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
__set()も参照してください。
| public mixed __get ( $name ) | ||
| $name | 文字列 |
プロパティ名 |
| 戻り値 | mixed |
プロパティ値またはビヘイビアのプロパティの値 |
|---|---|---|
| 例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
| 例外 | 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);
}
定義されている場所: yii\base\Component::__isset()
プロパティが設定されているかどうか（つまり、定義されていて null ではない）を確認します。
このメソッドは、以下の順序でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ：プロパティが設定されているかどうかを返す
- ビヘイビアのプロパティ：プロパティが設定されているかどうかを返す
- 存在しないプロパティの場合は
falseを返す
これはPHPのマジックメソッドであり、isset($component->property)を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
| public boolean __isset ( $name ) | ||
| $name | 文字列 |
プロパティ名またはイベント名 |
| 戻り値 | 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;
}
定義されている場所: yii\base\Component::__set()
コンポーネントプロパティの値を設定します。
このメソッドは、以下の順序でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ：プロパティ値を設定する
- "on xyz"形式のイベント："xyz"イベントにハンドラをアタッチする
- "as xyz"形式のビヘイビア："xyz"という名前のビヘイビアをアタッチする
- ビヘイビアのプロパティ：ビヘイビアのプロパティ値を設定する
これはPHPのマジックメソッドであり、$component->property = $value;を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
__get()も参照してください。
| public void __set ( $name, $value ) | ||
| $name | 文字列 |
プロパティ名またはイベント名 |
| $value | mixed |
プロパティ値 |
| 例外 | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
|---|---|---|
| 例外 | 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);
}
定義されている場所: yii\base\Component::__unset()
コンポーネントプロパティを null に設定します。
このメソッドは、以下の順序でチェックし、それに応じて動作します。
- セッターで定義されたプロパティ：プロパティ値をnullに設定する
- ビヘイビアのプロパティ：プロパティ値をnullに設定する
これはPHPのマジックメソッドであり、unset($component->property)を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。
| public void __unset ( $name ) | ||
| $name | 文字列 |
プロパティ名 |
| 例外 | 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);
}
このメソッドは、現在のテストに対してすべてのフィクスチャデータが読み込まれた後に呼び出されます。
| public void afterLoad ( ) |
public function afterLoad()
{
$this->checkIntegrity(true);
}
このメソッドは、現在のテストに対してすべてのフィクスチャデータがアンロードされた後に呼び出されます。
| public void afterUnload ( ) |
public function afterUnload()
{
$this->checkIntegrity(true);
}
定義先: yii\base\Component::attachBehavior()
このコンポーネントにビヘイビアをアタッチします。
このメソッドは、与えられた設定に基づいてビヘイビアオブジェクトを作成します。その後、yii\base\Behavior::attach()メソッドを呼び出すことで、ビヘイビアオブジェクトがこのコンポーネントにアタッチされます。
detachBehavior()も参照してください。
| public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
| $name | 文字列 |
ビヘイビアの名前。 |
| $behavior | string|array|yii\base\Behavior |
ビヘイビアの設定。以下のいずれかになります。
|
| 戻り値 | yii\base\Behavior |
ビヘイビアオブジェクト |
|---|---|---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
定義先: yii\base\Component::attachBehaviors()
コンポーネントにビヘイビアのリストをアタッチします。
各ビヘイビアは名前でインデックス付けされ、yii\base\Behaviorオブジェクト、ビヘイビアクラスを指定する文字列、またはビヘイビアを作成するための設定配列のいずれかである必要があります。
attachBehavior()も参照してください。
| public void attachBehaviors ( $behaviors ) | ||
| $behaviors | 配列 |
コンポーネントにアタッチされるビヘイビアのリスト |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
このメソッドは、現在のテストに対してフィクスチャデータが読み込まれる前に呼び出されます。
| public void beforeLoad ( ) |
public function beforeLoad()
{
$this->checkIntegrity(false);
}
このメソッドは、現在のテストに対してフィクスチャデータがアンロードされる前に呼び出されます。
| public void beforeUnload ( ) |
public function beforeUnload()
{
$this->checkIntegrity(false);
}
定義先: yii\base\Component::behaviors()
このコンポーネントがビヘイビアとして動作する必要があるビヘイビアのリストを返します。
子クラスはこのメソッドをオーバーライドして、ビヘイビアとして動作させたいビヘイビアを指定できます。
このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたは設定の配列である必要があります。ビヘイビアの設定は、ビヘイビアクラスを指定する文字列、または以下の構造の配列のいずれかになります。
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
ビヘイビアクラスはyii\base\Behaviorを拡張する必要があることに注意してください。ビヘイビアは、名前付きまたは匿名でアタッチできます。配列キーとして名前を使用する場合、この名前を使用して、getBehavior()でビヘイビアを取得したり、detachBehavior()でビヘイビアをデタッチしたりできます。匿名ビヘイビアは取得またはデタッチできません。
このメソッドで宣言されたビヘイビアは、自動的に（オンデマンドで）コンポーネントにアタッチされます。
| public array behaviors ( ) | ||
| 戻り値 | 配列 |
ビヘイビアの設定。 |
|---|---|---|
public function behaviors()
{
return [];
}
定義先: yii\base\Component::canGetProperty()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、以下の場合に読み取ることができます。
- クラスに指定された名前に関連付けられたゲッターメソッドがある場合（この場合、プロパティ名は大文字と小文字を区別しません）。
- クラスに指定された名前のメンバ変数がある場合（
$checkVarsがtrueの場合）。 - アタッチされたビヘイビアに、指定された名前の読み取り可能なプロパティがある場合（
$checkBehaviorsがtrueの場合）。
canSetProperty()も参照してください。
| public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 文字列 |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| $checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか |
| 戻り値 | 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;
}
定義先: yii\base\Component::canSetProperty()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、以下の場合に書き込むことができます。
- クラスに指定された名前に関連付けられたセッターメソッドがある場合（この場合、プロパティ名は大文字と小文字を区別しません）。
- クラスに指定された名前のメンバ変数がある場合（
$checkVarsがtrueの場合）。 - アタッチされたビヘイビアに、指定された名前の書き込み可能なプロパティがある場合（
$checkBehaviorsがtrueの場合）。
canGetProperty()も参照してください。
| public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 文字列 |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| $checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか |
| 戻り値 | 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;
}
DB の整合性チェックを切り替えます。
| public void checkIntegrity ( $check ) | ||
| $check | boolean |
整合性チェックをオンまたはオフにするかどうか。 |
public function checkIntegrity($check)
{
if (!$this->db instanceof \yii\db\Connection) {
return;
}
foreach ($this->schemas as $schema) {
$this->db->createCommand()->checkIntegrity($check, $schema)->execute();
}
}
定義位置: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
| public static string className ( ) | ||
| 戻り値 | 文字列 |
このクラスの完全修飾名。 |
|---|---|---|
public static function className()
{
return get_called_class();
}
定義位置: yii\base\Component::detachBehavior()
コンポーネントからビヘイビアをデタッチします。
ビヘイビアの yii\base\Behavior::detach() メソッドが呼び出されます。
| public yii\base\Behavior|null detachBehavior ( $name ) | ||
| $name | 文字列 |
ビヘイビアの名前。 |
| 戻り値 | 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;
}
定義位置: yii\base\Component::detachBehaviors()
コンポーネントからすべてのビヘイビアをデタッチします。
| public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
定義位置: 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);
}
}
}
定義位置: yii\base\Component::getBehavior()
名前付きビヘイビアオブジェクトを返します。
| public yii\base\Behavior|null getBehavior ( $name ) | ||
| $name | 文字列 |
ビヘイビア名 |
| 戻り値 | yii\base\Behavior|null |
ビヘイビアオブジェクト、またはビヘイビアが存在しない場合はnull |
|---|---|---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
定義位置: yii\base\Component::getBehaviors()
このコンポーネントにアタッチされているすべてのビヘイビアを返します。
| public yii\base\Behavior[] getBehaviors ( ) | ||
| 戻り値 | yii\base\Behavior[] |
このコンポーネントにアタッチされているビヘイビアのリスト |
|---|---|---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義位置: yii\base\Component::hasEventHandlers()
名前付きイベントにハンドラーがアタッチされているかどうかを示す値を返します。
| public boolean hasEventHandlers ( $name ) | ||
| $name | 文字列 |
イベント名 |
| 戻り値 | 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);
}
定義位置: yii\base\Component::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
メソッドが定義されている場合
- クラスに指定された名前のメソッドが存在する場合
- アタッチされたビヘイビアに指定された名前のメソッドが存在する場合（`$checkBehaviors` が true の場合）。
| public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
| $name | 文字列 |
プロパティ名 |
| $checkBehaviors | boolean |
ビヘイビアのメソッドをこのコンポーネントのメソッドとして扱うかどうか |
| 戻り値 | 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;
}
定義位置: yii\base\Component::hasProperty()
このコンポーネントのプロパティが定義されているかどうかを示す値を返します。
プロパティが定義されている場合
- クラスに、指定された名前と関連付けられたゲッターまたはセッターメソッドが存在する場合（この場合、プロパティ名はケースインセンシティブです）。
- クラスに指定された名前のメンバ変数がある場合（
$checkVarsがtrueの場合）。 - アタッチされたビヘイビアに指定された名前のプロパティが存在する場合（`$checkBehaviors` が true の場合）。
参照
| public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | 文字列 |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| $checkBehaviors | boolean |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか |
| 戻り値 | boolean |
プロパティが定義されているかどうか |
|---|---|---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
| public void init ( ) |
public function init()
{
parent::init();
$this->db = Instance::ensure($this->db, BaseObject::className());
}
フィクスチャを読み込みます。
このメソッドは、すべてのテストメソッドを実行する前に呼び出されます。フィクスチャの設定方法について、具体的な実装でこのメソッドをオーバーライドする必要があります。
| public void load ( ) |
public function load()
{
$file = Yii::getAlias($this->initScript);
if (is_file($file)) {
require $file;
}
}
定義位置: yii\base\Component::off()
このコンポーネントから既存のイベントハンドラーをデタッチします。
このメソッドは、on() の逆です。
注：イベント名にワイルドカードパターンが渡された場合、このワイルドカードで登録されたハンドラのみが削除され、このワイルドカードと一致するプレーン名で登録されたハンドラは残ります。
on() も参照してください。
| public boolean off ( $name, $handler = null ) | ||
| $name | 文字列 |
イベント名 |
| $handler | callable|null |
削除するイベントハンドラです。null の場合、指定されたイベントにアタッチされているすべてのハンドラが削除されます。 |
| 戻り値 | 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;
}
イベントにイベントハンドラーをアタッチします。
イベントハンドラは有効な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 | 文字列 |
イベント名 |
| $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]);
}
}
定義先: yii\base\Component::trigger()
イベントをトリガーします。
このメソッドはイベントの発生を表します。クラスレベルのハンドラを含む、イベントにアタッチされているすべてのハンドラを呼び出します。
| public void trigger ( $name, yii\base\Event $event = null ) | ||
| $name | 文字列 |
イベント名 |
| $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);
}
定義先: yii\test\Fixture::unload()
フィクスチャをアンロードします。
このメソッドは、各テストメソッドの終了後に呼び出されます。このメソッドをオーバーライドして、フィクスチャに必要なクリーンアップ作業を実行できます。
| public void unload ( ) |
public function unload()
{
}
サインアップ または ログイン してコメントしてください。