Yii數據提供者


Yii提供了一組封裝了分頁和排序數據提供程序類。數據提供者實現了 yii\data\DataProviderInterface 接口。它支持檢索排序和分頁數據。數據提供者通常是窗口小部件一起使用。
Yii 包括 -
  • ActiveDataProvider − 使用 yii\db\ActiveQuery 或 yii\db\Query 來從數據庫中查詢數據。

  • SqlDataProvider − 執行SQL語句並返回數組形式的數據。

  • ArrayDataProvider − 使用一個大的數組,並返回它的一個切片。

您可以通過配置分頁和排序的屬性來定義數據提供者的排序和分頁的行爲。數據窗口小部件,如:yii\grid\GridView,它有一個 dataProvider 屬性,它需要一個數據提供者實例,並在屏幕上顯示的數據。

準備數據庫

第1步 - 創建一個新的數據庫。數據庫可以通過以下兩種方式進行。
  • 在終端運行 mysql -u root –p

  • 登錄數據後,通過執行 CREATE DATABASE mystudy CHARACTER SET utf8 COLLATE utf8_general_ci; 創建一個新的數據庫;

第2步 - 在 config/db.php 文件中配置數據庫連接。下面的配置可根據自己的實際情況配置。
<?php
   return [
      'class' => 'yii\db\Connection',
      'dsn' => 'mysql:host = localhost;dbname = mystudy',
      'username' => 'root',
      'password' => '',
      'charset' => 'utf8',
   ];
?>

第3步 - 在項目根文件夾執行:yii migrate/create test_table 。此命令將用於創建管理數據庫數據庫遷移。 migrations文件會出現在項目的根的 migrations 文件夾中。
Yii數據提供者

第4步 - 修改遷移文件(在本示例中生成的是:m160529_014611_test_table.php),並使用以下這些代碼。
<?php
   use yii\db\Schema;
   use yii\db\Migration;
   class m160529_014611_test_table extends Migration {
      public function up() {
         $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 down() {
         //$this->dropTable('user');
      }
   }
?>
上述遷移創建用戶表,它包含了以下這些字段:id, name, 和 email。它還增加了一些演示用戶帳號。
第5步 - 在項目的根目錄內運行: yii migrate  來遷移應用到數據庫。執行結果如下圖所示:
Yii數據提供者

第6步-現在,我們需要爲user表創建模型。爲了簡便起見,我們將使用GII代碼生成工具。在瀏覽器中打開 url: http://localhost:8080/index.php?r=gii 。
然後,點擊 「Model generator」 下的 「Start」按鈕。 填寫表名(「user」)和模型類(「MyUser」),單擊「Preview」按鈕,最後點擊 「Generate」 按鈕。

Yii數據提供者
Yii數據提供者
MyUser 文件憶經生成在 models 目錄。

Active數據提供者

第1步 - 創建一個 activeDataProvider() 方法在 SiteController 中。
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應用程序組件作爲數據庫連接。

第2步 - 如果在瀏覽器中打開URL:  http://localhost:8080/index.php?r=site/data-provider, 會看到下面的輸出。
Yii數據提供者

SQL數據提供者

yii\data\SqlDataProvider 類是使用原始的SQL語句方式工作的。
第1步 - 使用以下這種方式修改 DataProvider() 方法。
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 ,會看到下面的輸出。
Yii數據提供者

數組數據提供者

yii\data\ArrayDataProvider 類是使用大數組是最好的方式。此數組中元素可以是 DAO 的任何查詢結果或 ActiveRecord 的實例。
第1步 - 使用以下這種方式修改 DataProvider() 方法。
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步 - 打開網絡瀏覽器並訪問地址  http://localhost:8080/index.php?r=site/data-provider ,會看到下面的輸出。
Yii數據提供者
請注意,不同於SQL數據提供者和Active數據提供者,數組數據提供程序會加載所有數據到內存中,所以它是效率較低。