抽象クラス yii\data\BaseDataProvider
BaseDataProviderは、yii\data\DataProviderInterfaceを実装する基底クラスを提供します。
BaseDataProviderの詳細と使用方法については、データプロバイダに関するガイド記事を参照してください。
公開プロパティ
| プロパティ | 型 | 説明 | 定義元 |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | このコンポーネントにアタッチされているビヘイビアのリスト。 | yii\base\Component |
| $count | integer | 現在のページにあるデータモデルの数。 | yii\data\BaseDataProvider |
| $id | string|null | すべてのデータプロバイダの中で、データプロバイダを一意に識別するID。 | yii\data\BaseDataProvider |
| $keys | array | $modelsに対応するキー値のリスト。 | yii\data\BaseDataProvider |
| $models | array | 現在のページにあるデータモデルのリスト。 | yii\data\BaseDataProvider |
| $pagination | yii\data\Pagination|false | ページネーションオブジェクト。 | yii\data\BaseDataProvider |
| $sort | yii\data\Sort|boolean | ソートオブジェクト。 | yii\data\BaseDataProvider |
| $totalCount | integer | 可能なデータモデルの総数。 | yii\data\BaseDataProvider |
公開メソッド
保護されたメソッド
| メソッド | 説明 | 定義元 |
|---|---|---|
| prepareKeys() | 現在利用可能なデータモデルに関連付けられたキーを準備します。 | yii\data\BaseDataProvider |
| prepareModels() | 現在のページで利用可能になるデータモデルを準備します。 | yii\data\BaseDataProvider |
| prepareTotalCount() | このデータプロバイダにあるデータモデルの総数を示す値を返します。 | yii\data\BaseDataProvider |
プロパティの詳細
すべてのデータプロバイダの中で、データプロバイダを一意に識別するID。設定されていない場合、次のように自動的に生成されます。
- 最初のデータプロバイダのIDは空です。
- 2番目以降のデータプロバイダのIDは、「dp-1」、「dp-2」などです。
ページネーションオブジェクト。falseの場合、ページネーションは無効になります。このプロパティの型は、ゲッターとセッターで異なります。getPagination()とsetPagination()を参照してください。
メソッドの詳細
定義場所: yii\base\Component::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、アタッチされたビヘイビアに指定されたメソッドがあるかどうかをチェックし、存在する場合は実行します。
これはPHPのマジックメソッドであり、未知のメソッドが呼び出された際に暗黙的に呼び出されるため、直接呼び出さないでください。
| public mixed __call ( $name, $params ) | ||
| $name | string |
メソッド名 |
| $params | array |
メソッドパラメータ |
| 戻り値 | 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 | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
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 | string |
プロパティ名 |
| 戻り値 | 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 | string |
プロパティ名またはイベント名 |
| 戻り値 | 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 | string |
プロパティ名またはイベント名 |
| $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 | string |
プロパティ名 |
| 例外 | 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);
}
定義先: yii\base\Component::attachBehavior()
このコンポーネントにビヘイビアをアタッチします。
このメソッドは、指定された設定に基づいてビヘイビアオブジェクトを作成します。その後、yii\base\Behavior::attach() メソッドを呼び出すことで、ビヘイビアオブジェクトがこのコンポーネントにアタッチされます。
参考: detachBehavior().
| public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
| $name | string |
ビヘイビアの名前。 |
| $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 | array |
コンポーネントにアタッチされるビヘイビアのリスト |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
定義先: yii\base\Component::behaviors()
このコンポーネントがビヘイビアとして持つべきビヘイビアのリストを返します。
子クラスでは、このメソッドをオーバーライドして、ビヘイビアとして動作させたいビヘイビアを指定できます。
このメソッドの戻り値は、ビヘイビア名でインデックス付けされたビヘイビアオブジェクトまたは設定の配列である必要があります。ビヘイビア設定は、ビヘイビアクラスを指定する文字列、または以下の構造の配列のいずれかです。
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
ビヘイビアクラスは yii\base\Behavior から拡張する必要があることに注意してください。ビヘイビアは、名前付きまたは匿名でアタッチできます。配列キーとして名前が使用されている場合、この名前を使用して、getBehavior() を使用して後でビヘイビアを取得したり、detachBehavior() を使用してデタッチしたりできます。匿名ビヘイビアは取得またはデタッチできません。
このメソッドで宣言されたビヘイビアは、自動的に（オンデマンドで）コンポーネントにアタッチされます。
| public array behaviors ( ) | ||
| 戻り値 | 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 |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか |
| 戻り値 | 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 |
ビヘイビアのプロパティをこのコンポーネントのプロパティとして扱うかどうか |
| 戻り値 | 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 ( ) | ||
| 戻り値 | 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 |
ビヘイビアの名前。 |
| 戻り値 | 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 |
ビヘイビア名 |
| 戻り値 | 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;
}
現在のページにあるデータモデルの数を返します。
| public integer getCount ( ) | ||
| 戻り値 | integer |
現在のページにあるデータモデルの数。 |
|---|---|---|
public function getCount()
{
return count($this->getModels());
}
データモデルに関連付けられたキー値を返します。
| public array getKeys ( ) | ||
| 戻り値 | array |
$modelsに対応するキー値のリスト。$modelsの各データモデルはこの配列内の対応するキー値によって一意に識別されます。 |
|---|---|---|
public function getKeys()
{
$this->prepare();
return $this->_keys;
}
現在のページにあるデータモデルを返します。
| public array getModels ( ) | ||
| 戻り値 | array |
現在のページにあるデータモデルのリスト。 |
|---|---|---|
public function getModels()
{
$this->prepare();
return $this->_models;
}
このデータプロバイダで使用されているページネーションオブジェクトを返します。
prepare() または getModels() を先に呼び出して、yii\data\Pagination::$totalCount と yii\data\Pagination::$pageCount の正しい値を取得する必要があることに注意してください。
| public yii\data\Pagination|false getPagination ( ) | ||
| 戻り値 | yii\data\Pagination|false |
ページングオブジェクト。falseの場合は、ページングが無効になっていることを意味します。 |
|---|---|---|
public function getPagination()
{
if ($this->_pagination === null) {
$this->setPagination([]);
}
return $this->_pagination;
}
このデータプロバイダで使用されているソートオブジェクトを返します。
| public yii\data\Sort|boolean getSort ( ) | ||
| 戻り値 | yii\data\Sort|boolean |
ソートオブジェクト。falseの場合は、ソートが無効になっていることを意味します。 |
|---|---|---|
public function getSort()
{
if ($this->_sort === null) {
$this->setSort([]);
}
return $this->_sort;
}
データモデルの総数を返します。
$pagination がfalseの場合、これは$countと同じ値を返します。それ以外の場合は、カウントを取得するためにprepareTotalCount()を呼び出します。
| public integer getTotalCount ( ) | ||
| 戻り値 | integer |
可能なデータモデルの総数。 |
|---|---|---|
public function getTotalCount()
{
if ($this->getPagination() === false) {
return $this->getCount();
} elseif ($this->_totalCount === null) {
$this->_totalCount = $this->prepareTotalCount();
}
return $this->_totalCount;
}
定義先: yii\base\Component::hasEventHandlers()
名前付きイベントにハンドラがアタッチされているかどうかを示す値を返します。
| public boolean hasEventHandlers ( $name ) | ||
| $name | string |
イベント名 |
| 戻り値 | 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 |
ビヘイビアのメソッドをこのコンポーネントのメソッドとして扱うかどうか |
| 戻り値 | 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()
このコンポーネントのプロパティが定義されているかどうかを示す値を返します。
プロパティは、以下の場合に定義されているとみなされます。
- クラスが指定された名前と関連付けられたgetterまたはsetterメソッドを持つ場合（この場合、プロパティ名は大文字と小文字を区別しません）。
- クラスに、指定された名前のメンバ変数がある場合（
$checkVarsが true の場合）。 - アタッチされたビヘイビアが指定された名前のプロパティを持つ場合（
$checkBehaviorsがtrueの場合）。
参照
| public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
| $name | string |
プロパティ名 |
| $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();
if ($this->id === null) {
if (self::$counter > 0) {
$this->id = 'dp-' . self::$counter;
}
self::$counter++;
}
}
定義先: yii\base\Component::off()
このコンポーネントから既存のイベントハンドラをデタッチします。
このメソッドは、on()の反対です。
注記: イベント名にワイルドカードパターンが渡された場合、このワイルドカードで登録されたハンドラのみが削除され、このワイルドカードに一致するプレーン名で登録されたハンドラは残ります。
こちらも参照してください on().
| public boolean off ( $name, $handler = null ) | ||
| $name | string |
イベント名 |
| $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 | 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]);
}
}
データモデルとキーを準備します。
このメソッドは、getModels() と getKeys() を介して取得できるデータモデルとキーを準備します。
このメソッドは、以前に呼び出されていない場合、getModels() と getKeys() によって暗黙的に呼び出されます。
| public void prepare ( $forcePrepare = false ) | ||
| $forcePrepare | boolean |
以前にデータ準備が済んでいても強制的にデータ準備を行うかどうか。 |
public function prepare($forcePrepare = false)
{
if ($forcePrepare || $this->_models === null) {
$this->_models = $this->prepareModels();
}
if ($forcePrepare || $this->_keys === null) {
$this->_keys = $this->prepareKeys($this->_models);
}
}
現在利用可能なデータモデルに関連付けられたキーを準備します。
| protected abstract array prepareKeys ( $models ) | ||
| $models | array |
利用可能なデータモデル |
| 戻り値 | array |
キー |
|---|---|---|
abstract protected function prepareKeys($models);
現在のページで利用可能になるデータモデルを準備します。
| protected abstract array prepareModels ( ) | ||
| 戻り値 | array |
利用可能なデータモデル |
|---|---|---|
abstract protected function prepareModels();
このデータプロバイダにあるデータモデルの総数を示す値を返します。
| protected abstract integer prepareTotalCount ( ) | ||
| 戻り値 | integer |
このデータプロバイダ内のデータモデルの総数。 |
|---|---|---|
abstract protected function prepareTotalCount();
データプロバイダを更新します。
このメソッドを呼び出した後、getModels()、getKeys()、または getTotalCount() が再度呼び出されると、クエリが再実行され、利用可能な最新のデータが返されます。
| public void refresh ( ) |
public function refresh()
{
$this->_totalCount = null;
$this->_models = null;
$this->_keys = null;
}
データモデルに関連付けられたキー値を設定します。
| public void setKeys ( $keys ) | ||
| $keys | array |
$modelsに対応するキー値のリスト。 |
public function setKeys($keys)
{
$this->_keys = $keys;
}
現在のページにあるデータモデルを設定します。
| public void setModels ( $models ) | ||
| $models | array |
現在のページのモデル |
public function setModels($models)
{
$this->_models = $models;
}
このデータプロバイダのページネーションを設定します。
| public void setPagination ( $value ) | ||
| $value | array|yii\data\Pagination|boolean |
このデータプロバイダで使用されるページネーション。以下のいずれかになります。
|
| 例外 | yii\base\InvalidArgumentException | |
|---|---|---|
public function setPagination($value)
{
if (is_array($value)) {
$config = ['class' => Pagination::className()];
if ($this->id !== null) {
$config['pageParam'] = $this->id . '-page';
$config['pageSizeParam'] = $this->id . '-per-page';
}
$this->_pagination = Yii::createObject(array_merge($config, $value));
} elseif ($value instanceof Pagination || $value === false) {
$this->_pagination = $value;
} else {
throw new InvalidArgumentException('Only Pagination instance, configuration array or false is allowed.');
}
}
このデータプロバイダのソート定義を設定します。
| public void setSort ( $value ) | ||
| $value | 配列|yii\data\Sort|ブール値 |
このデータプロバイダーで使用されるソート定義。以下のいずれかになります。
|
| 例外 | yii\base\InvalidArgumentException | |
|---|---|---|
public function setSort($value)
{
if (is_array($value)) {
$config = ['class' => Sort::className()];
if ($this->id !== null) {
$config['sortParam'] = $this->id . '-sort';
}
$this->_sort = Yii::createObject(array_merge($config, $value));
} elseif ($value instanceof Sort || $value === false) {
$this->_sort = $value;
} else {
throw new InvalidArgumentException('Only Sort instance, configuration array or false is allowed.');
}
}
データモデルの総数を設定します。
| public void setTotalCount ( $value ) | ||
| $value | integer |
データモデルの総数。 |
public function setTotalCount($value)
{
$this->_totalCount = $value;
}
定義場所: 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);
}
コメントするにはサインアップまたはログインしてください。