0 フォロワー

インターフェース yii\data\DataProviderInterface

実装クラス	yii\data\ActiveDataProvider、 yii\data\ArrayDataProvider、 yii\data\BaseDataProvider、 yii\data\SqlDataProvider
利用可能バージョン	2.0
ソースコード	https://github.com/yiisoft/yii2/blob/master/framework/data/DataProviderInterface.php

DataProviderInterface は、データプロバイダークラスで実装する必要があるインターフェースです。

データプロバイダーは、データをソートおよびページネーションし、yii\grid\GridView、yii\widgets\ListViewなどのウィジェットにデータを提供するコンポーネントです。

DataProviderInterfaceの詳細と使用方法については、データプロバイダーに関するガイド記事を参照してください。

公開メソッド

メソッド	説明	定義元
getCount()	現在のページのデータモデルの数を返します。	yii\data\DataProviderInterface
getKeys()	データモデルに関連付けられたキー値を返します。	yii\data\DataProviderInterface
getModels()	現在のページのデータモデルを返します。	yii\data\DataProviderInterface
getPagination()		yii\data\DataProviderInterface
getSort()		yii\data\DataProviderInterface
getTotalCount()	データモデルの総数を返します。	yii\data\DataProviderInterface
prepare()	データモデルとキーを準備します。	yii\data\DataProviderInterface

getCount() public abstract method

現在のページのデータモデルの数を返します。

これはcount($provider->getModels())と同等です。ページネーションがfalseの場合、これはtotalCountと同じです。

public abstract integer getCount ( )
戻り値	integer	現在のページのデータモデルの数。

                public function getCount();

getKeys() public abstract method

データモデルに関連付けられたキー値を返します。

public abstract array getKeys ( )
戻り値	array	modelsに対応するキー値のリスト。 models内の各データモデルはこの配列内の対応するキー値によって一意に識別されます。

                public function getKeys();

getModels() public abstract method

現在のページのデータモデルを返します。

public abstract array getModels ( )
戻り値	array	現在のページのデータモデルのリスト。

                public function getModels();

getPagination() public abstract method

public abstract yii\data\Pagination\|false getPagination ( )
戻り値	yii\data\Pagination\|false	ページネーションオブジェクト。falseの場合、ページネーションは無効です。

                public function getPagination();

getSort() public abstract method

public abstract yii\data\Sort\|false getSort ( )
戻り値	yii\data\Sort\|false	ソートオブジェクト。falseの場合は、ソートが無効になっています。

                public function getSort();

getTotalCount() public abstract method

データモデルの総数を返します。

ページネーションがfalseの場合、これはcountと同じです。

public abstract integer getTotalCount ( )
戻り値	integer	可能なデータモデルの総数。

                public function getTotalCount();

prepare() public abstract method

データモデルとキーを準備します。

このメソッドは、getModels() と getKeys() を介して取得できるデータモデルとキーを準備します。

このメソッドは、以前に呼び出されていない場合、getModels() と getKeys() によって暗黙的に呼び出されます。

public abstract void prepare ( $forcePrepare = false )
$forcePrepare	boolean	以前に実行済みであっても、データの準備を強制的に実行するかどうか。

                public function prepare($forcePrepare = false);