Yii - 数据提供者 - 菜鸟教程

简述

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

这包括 -

ActiveDataProvider - 使用yii \db\ActiveQuery或yii\db\Query从数据库中查询数据。
SqlDataProvider - 执行 SQL 并将数据作为数组返回。
ArrayDataProvider - 获取一个大数组并返回其中的一部分。

您可以通过配置数据提供者的分页和排序属性来定义其排序和分页行为。数据小部件，例如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。该命令将创建一个数据库迁移来管理我们的数据库。迁移文件应该出现在项目根目录的迁移文件夹中。

第 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", "user1@gmail.com"],
            ["User2", "user2@gmail.com"],
            ["User3", "user3@gmail.com"],
            ["User4", "user4@gmail.com"],
            ["User5", "user5@gmail.com"],
            ["User6", "user6@gmail.com"],
            ["User7", "user7@gmail.com"],
            ["User8", "user8@gmail.com"],
            ["User9", "user9@gmail.com"],
            ["User10", "user10@gmail.com"],
            ["User11", "user11@gmail.com"],
         ]);
      }
      public function safeDown() {
         $this->dropTable('user');
      }
   }
?>

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

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

第 6 步- 现在，我们需要为我们的用户表创建一个模型。为了简单起见，我们将使用Gii代码生成工具。打开这个网址： http://localhost:8080/index.php?r=gii。然后，单击“模型生成器”标题下的“开始”按钮。填写表名（“user”）和模型类（“MyUser”），点击“Preview”按钮，最后点击“Generate”按钮。

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，您将看到以下输出。

数组数据提供者

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 Data Provider 和 Active Data Provider 不同，Array Data Provider 会将所有数据加载到内存中，因此效率较低。