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", "[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」 按鈕。



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資料提供者,陣列資料提供程式會載入所有資料到記憶體中,所以它是效率較低。