クラス yii\test\Fixture
Fixture はテスト環境の固定された状態を表します。
各 fixture インスタンスは、テスト環境の特定の一側面を表します。たとえば、既知のデータセットでユーザーデータベーステーブルを初期化するために UserFixture を使用できます。fixture は各テストメソッドを実行するときにロードできるため、ユーザーテーブルには常に固定データが含まれ、テストの予測可能性と再現性が向上します。
fixture は、$depends プロパティで指定された、他の fixture に依存する場合があります。fixture がロードされるとき、その依存 fixture はその fixture の前に自動的にロードされます。また、fixture がアンロードされるとき、その依存 fixture はその fixture の後にアンロードされます。
通常、fixture を設定する方法を指定するには load() をオーバーライドする必要があります。fixture をクリアするには unload() をオーバーライドする必要があります。
Fixture の詳細と使用方法については、fixture に関するガイド記事を参照してください。
パブリックプロパティ
| プロパティ | 型 | 説明 | 定義元 |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | このコンポーネントにアタッチされたビヘイビアのリスト。 | yii\base\Component |
| $depends | array | この fixture が依存する fixture。 | yii\test\Fixture |
パブリックメソッド
| メソッド | 説明 | 定義元 |
|---|---|---|
| __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 |
| 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\base\BaseObject |
| load() | fixture をロードします。 | yii\test\Fixture |
| off() | このコンポーネントから既存のイベントハンドラーをデタッチします。 | yii\base\Component |
| on() | イベントにイベントハンドラーをアタッチします。 | yii\base\Component |
| trigger() | イベントをトリガーします。 | yii\base\Component |
| unload() | fixture をアンロードします。 | yii\test\Fixture |
プロパティの詳細
メソッドの詳細
定義元: 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()");
}
定義元: 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 | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義元: yii\base\Component::__get()
コンポーネントプロパティの値を返します。
このメソッドは、次の順序でチェックし、それに応じて動作します。
- ゲッターによって定義されたプロパティ：ゲッターの結果を返す
- ビヘイビアのプロパティ：ビヘイビアのプロパティ値を返す
$value = $component->property;を実行すると暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。
また、__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);
}
定義元: yii\base\Component::__isset()
プロパティが設定されている、つまり定義されていて null でないかどうかを確認します。
このメソッドは、次の順序でチェックし、それに応じて動作します。
- セッターによって定義されたプロパティ：プロパティが設定されているかどうかを返す
- ビヘイビアのプロパティ：プロパティが設定されているかどうかを返す
- 存在しないプロパティの場合は
falseを返す
isset($component->property)を実行すると暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。
また、https://www.php.net/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;
}
定義元: yii\base\Component::__set()
コンポーネントプロパティの値を設定します。
このメソッドは、次の順序でチェックし、それに応じて動作します。
- セッターによって定義されたプロパティ：プロパティ値を設定する
- "on xyz" の形式のイベント：イベント "xyz" にハンドラをアタッチする
- "as xyz" の形式のビヘイビア： "xyz" という名前のビヘイビアをアタッチする
- ビヘイビアのプロパティ：ビヘイビアのプロパティ値を設定する
$component->property = $value;を実行すると暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。
また、__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);
}
定義元: yii\base\Component::__unset()
コンポーネントプロパティを null に設定します。
このメソッドは、次の順序でチェックし、それに応じて動作します。
- セッターによって定義されたプロパティ：プロパティ値をnullに設定する
- ビヘイビアのプロパティ：プロパティ値をnullに設定する
unset($component->property)を実行すると暗黙的に呼び出されるPHPのマジックメソッドであるため、このメソッドを直接呼び出さないでください。
また、https://www.php.net/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);
}
このメソッドは、現在のテストのためにすべての fixture データがロードされた後に呼び出されます。
| public void afterLoad ( ) |
public function afterLoad()
{
}
このメソッドは、現在のテストのためにすべての fixture データがアンロードされた後に呼び出されます。
| public void afterUnload ( ) |
public function afterUnload()
{
}
定義元: 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);
}
定義元: 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);
}
}
このメソッドは、現在のテストのために fixture データがロードされる前に呼び出されます。
| public void beforeLoad ( ) |
public function beforeLoad()
{
}
このメソッドは、現在のテストのために fixture データがアンロードされる前に呼び出されます。
| public void beforeUnload ( ) |
public function beforeUnload()
{
}
定義元: 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 [];
}
定義元: yii\base\Component::canGetProperty()
プロパティを読み取ることができるかどうかを示す値を返します。
プロパティは、次の場合に読み取り可能です。
- クラスに指定された名前に関連付けられたゲッターメソッドがある場合（この場合、プロパティ名はケースインセンシティブです）。
- クラスに指定された名前のメンバー変数がある場合（
$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;
}
定義元: yii\base\Component::canSetProperty()
プロパティを設定できるかどうかを示す値を返します。
プロパティは、次の場合に書き込み可能です。
- クラスに指定された名前に関連付けられたセッターメソッドがある場合（この場合、プロパティ名はケースインセンシティブです）。
- クラスに指定された名前のメンバー変数がある場合（
$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;
}
::classを使用してください。
定義元: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
| public static string className ( ) | ||
| return | string |
このクラスの完全修飾名。 |
|---|---|---|
public static function className()
{
return get_called_class();
}
定義元: 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;
}
定義元: 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 | string |
ビヘイビア名 |
| return | 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 ( ) | ||
| return | yii\base\Behavior[] |
このコンポーネントにアタッチされたビヘイビアのリスト |
|---|---|---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
定義元: 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);
}
定義元: 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;
}
定義元: yii\base\Component::hasProperty()
このコンポーネントにプロパティが定義されているかどうかを示す値を返します。
プロパティは、次の場合に定義されます。
- クラスが指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合（この場合、プロパティ名はケースインセンシティブです）。
- クラスに指定された名前のメンバー変数がある場合（
$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);
}
| public void init ( ) |
public function init()
{
}
fixture をロードします。
このメソッドは、すべてのテストメソッドを実行する前に呼び出されます。フィクスチャの設定方法に関する具体的な実装でこのメソッドをオーバーライドする必要があります。
| public void load ( ) |
public function load()
{
}
定義元: 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;
}
イベントにイベントハンドラーをアタッチします。
イベントハンドラは有効な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]);
}
}
定義元: 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);
}
サインアップ または ログイン してコメントしてください。