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 檔夾中。

第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", "user11@gmail.com"],
            ["User2", "user22@gmail.com"],
            ["User3", "user33@gmail.com"],
            ["User4", "user44@gmail.com"],
            ["User5", "user55@gmail.com"],
            ["User6", "user66@gmail.com"],
            ["User7", "user77@gmail.com"],
            ["User8", "user88@gmail.com"],
            ["User9", "user99@gmail.com"],
            ["User10", "user1010@gmail.com"],
            ["User11", "user1111@gmail.com"],
         ]);
      }
      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” 按鈕。



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, 會看到下麵的輸出。

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\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 ,會看到下麵的輸出。

請注意,不同於SQL數據提供者和Active數據提供者,數組數據提供程式會加載所有數據到記憶體中,所以它是效率較低。

上一篇: Yii屬性 下一篇: Yii數據Widgets