Yii - 数据提供器

---

---

Yii 提供了一组数据提供器类，封装了分页和排序功能。数据提供器实现 yii\data\DataProviderInterface 接口。它支持检索排序和分页的数据。数据提供器通常与数据小部件一起使用。

Yii 包括 -

• ActiveDataProvider - 使用 yii\db\ActiveQuery 或 yii\db\Query 从数据库查询数据。

• SqlDataProvider - 执行 SQL 并将数据作为数组返回。

• ArrayDataProvider - 获取一个大数组并返回其中的一部分。

通过配置其 pagination 和 sort 属性，可以定义数据提供器的排序和分页行为。数据小部件（如 yii\grid\GridView）有一个名为 dataProvider 的属性，该属性接收数据提供器实例并在屏幕上显示数据。

准备数据库

步骤 1 - 创建一个新的数据库。可以通过以下两种方式准备数据库。

• 在终端运行 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。此命令将创建一个用于管理我们数据库的数据库迁移。迁移文件应出现在项目根目录的 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');
      }
   }
?>

上述迁移创建了一个名为 user 的表，包含以下字段：id、name 和 email。它还添加了一些演示用户。

步骤 5 - 在项目根目录内运行 ./yii migrate 将迁移应用到数据库。

步骤 6 - 现在，我们需要为 user 表创建一个模型。为简单起见，我们将使用 Gii 代码生成工具。打开此 url: https://127.0.0.1:8080/index.php?r=gii。然后，单击“Model generator”标题下的“Start”按钮。填写表名（“user”）和模型类（“MyUser”），单击“Preview”按钮，最后单击“Generate”按钮。

MyUser 模型应该出现在 models 目录中。

活动数据提供器

步骤 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 应用组件作为数据库连接。

步骤 2 - 如果输入本地主机地址 https://127.0.0.1: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 - 在网页浏览器的地址栏中输入 https://127.0.0.1:8080/index.php?r=site/data-provider，您将看到以下输出。

数组数据提供器

yii\data\ArrayDataProvider 类最适合处理大型数组。此数组中的元素可以是 DAO 或活动记录实例的查询结果。

步骤 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 - 如果通过网页浏览器访问地址 https://127.0.0.1:8080/index.php?r=site/data-provider，您将看到以下输出。

请注意，与 SQL 数据提供器和活动数据提供器不同，数组数据提供器将所有数据加载到内存中，因此效率较低。