Yii-データプロバイダー

Yiiは、ページネーションとソートをカプセル化するデータプロバイダークラスのセットを提供します。データプロバイダーはyii \ data \ DataProviderInterfaceを実装します。ソートおよびページ分割されたデータの取得をサポートします。通常、データプロバイダーはデータウィジェットを使用します。

Yiiには-

ActiveDataProvider - yii \ db \ ActiveQuery または yii \ db \ Query を使用して、データベースからデータをクエリします。
SqlDataProvider -SQLを実行し、配列としてデータを返します。
ArrayDataProvider -大きな配列を受け取り、そのスライスを返します。

データプロバイダーの pagination および sort プロパティを構成することで、データプロバイダーの並べ替えとページネーションの動作を定義します。 yii \ grid \ GridView などのデータウィジェットには、 dataProvider というプロパティがあります。このプロパティは、データプロバイダーインスタンスを取得し、画面にデータを表示します。

DBの準備

ステップ1 *-新しいデータベースを作成します。データベースは、次の2つの方法で準備できます。

ターミナルで_mysql -u root –p_を実行します。
CREATE DATABASE helloworld CHARACTER SET utf8 COLLATE utf8_general_ciで新しいデータベースを作成します。

ステップ2 *- *config/db.php ファイルでデータベース接続を設定します。次の構成は、現在使用されているシステム用です。

<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = helloworld',
      'username' => 'vladimir',
      'password' => '12345',
      'charset' => 'utf8',
   ];
?>

ステップ3 *-ルートフォルダー内で./yii migrate/create test_table *を実行します。このコマンドは、DBを管理するためのデータベース移行を作成します。移行ファイルは、プロジェクトルートの *migrations フォルダーに表示されます。

ステップ4 *-この方法で移行ファイル（この場合は *m160106_163154_test_table.php ）を変更します。

<?php
   use yii\db\Schema;
   use yii\db\Migration;
   class m160106_163154_test_table extends Migration {
      public function safeUp() {
         $this->createTable("user", [
            "id" => Schema::TYPE_PK,
            "name" => Schema::TYPE_STRING,
            "email" => Schema::TYPE_STRING,
         ]);
         $this->batchInsert("user", ["name", "email"], [
            ["User1", "[email protected]"],
            ["User2", "[email protected]"],
            ["User3", "[email protected]"],
            ["User4", "[email protected]"],
            ["User5", "[email protected]"],
            ["User6", "[email protected]"],
            ["User7", "[email protected]"],
            ["User8", "[email protected]"],
            ["User9", "[email protected]"],
            ["User10", "[email protected]"],
            ["User11", "[email protected]"],
         ]);
      }
      public function safeDown() {
         $this->dropTable('user');
      }
   }
?>

上記の移行では、id、name、およびemailのフィールドを持つ user テーブルが作成されます。また、いくつかのデモユーザーを追加します。

ステップ5 *-プロジェクトのルート内で./yii migrate *を実行して、データベースに移行を適用します。

ステップ6 *-次に、 *user テーブルのモデルを作成する必要があります。簡単にするために、 Gii コード生成ツールを使用します。この url：http：//localhost：8080/index.php？r = gii を開きます。次に、「Model generator」ヘッダーの下にある「Start」ボタンをクリックします。テーブル名（「ユーザー」）とモデルクラス（「MyUser」）を入力し、「プレビュー」ボタンをクリックして、最後に「生成」ボタンをクリックします。

ボタンを生成

MyUserモデルがモデルディレクトリに表示されます。

アクティブデータプロバイダー

ステップ1 *- *SiteController 内に actionDataProvider という関数を作成します。

public function actionDataProvider(){
   $query = MyUser::find();
   $provider = new ActiveDataProvider([
      'query' => $query,
      'pagination' => [
         'pageSize' => 2,
      ],
   ]);
  //returns an array of users objects
   $users = $provider->getModels();
   var_dump($users);
}

上記のコードでは、 ActiveDataProvider クラスのインスタンスを定義し、最初のページからユーザーを表示します。 yii \ data \ ActiveDataProvider クラスは、DBアプリケーションコンポーネントをDB接続として使用します。

ステップ2 *-ローカルホストアドレス *http：//localhost：8080/index.php？r = site/dataprovider を入力すると、次の出力が表示されます。

アクティブデータプロバイダー

SQLデータプロバイダー

*yii \ data \ SqlDataProvider* クラスは、生のSQLステートメントで機能します。

ステップ1 *-この方法で *actionDataProvider メソッドを変更します。

public function actionDataProvider() {
   $count = Yii::$app->db->createCommand('SELECT COUNT(*) FROM user')->queryScalar();
   $provider = new SqlDataProvider([
      'sql' => 'SELECT * FROM user',
      'totalCount' => $count,
      'pagination' => [
         'pageSize' => 5,
      ],
      'sort' => [
         'attributes' => [
            'id',
            'name',
            'email',
         ],
      ],
   ]);
  //returns an array of data rows
   $users = $provider->getModels();
   var_dump($users);
}

ステップ2 *-Webブラウザーのアドレスバーに *http：//localhost：8080/index.php？r = site/data-provider と入力すると、次の出力が表示されます。

SQLデータプロバイダーの出力

配列データプロバイダー

*yii \ data \ ArrayDataProvider* クラスは、大きな配列を扱うのに最適です。 この配列の要素は、DAOのクエリ結果またはActive Recordインスタンスのいずれかです。

ステップ1 *-この方法で *actionDataProvider メソッドを変更します。

public function actionDataProvider() {
   $data = MyUser::find()->asArray()->all();
   $provider = new ArrayDataProvider([
      'allModels' => $data,
      'pagination' => [
         'pageSize' => 3,
      ],
      'sort' => [
         'attributes' => ['id', 'name'],
      ],
   ]);
  //get the rows in the currently requested page
   $users = $provider->getModels();
   var_dump($users);
}

ステップ2 *-Webブラウザからアドレス *http：//localhost：8080/index.php？r = site/data-provider にアクセスすると、次の出力が表示されます。

配列データプロバイダーの出力

SQLデータプロバイダーやアクティブデータプロバイダーとは異なり、配列データプロバイダーはすべてのデータをメモリにロードするため、効率が低いことに注意してください。

Yii-data-providers

目次

Yii-データプロバイダー

DBの準備

アクティブデータプロバイダー

SQLデータプロバイダー

配列データプロバイダー