Yii - 数据提供者

更新于 2025/2/12 4:22:17

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 migration/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", "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');
      }
   }
?>

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

步骤 5 − 在项目根目录下 运行 ./yii migration 以将迁移应用于数据库。

步骤 6 − 现在，我们需要为我们的 user 表创建一个模型。为简单起见，我们将使用 Gii 代码生成工具。打开此 url:http://localhost:8080/index.php?r=gii。然后，单击"模型生成器"标题下的"开始"按钮。填写表名称("user")和模型类("MyUser")，单击"预览"按钮，最后单击"生成"按钮。

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

活动数据提供程序

步骤 1 − 在 SiteController 内创建一个名为 actionDataProvider 的函数。

public function actionDataProvider(){
   $query = MyUser::find();
   $provider = new ActiveDataProvider([
      'query' => $query,
      'pagination' => [
         'pageSize' => 2,
      ],
   ]);
   // 返回用户对象数组
   $users = $provider->getModels();
   var_dump($users);
}

在上面的代码中，我们定义了一个 ActiveDataProvider 类的实例，并从第一页显示用户。yii\data\ActiveDataProvider 类使用 DB 应用程序组件作为 DB 连接。

步骤 2 − 如果您输入本地主机地址 http://localhost:8080/index.php?r=site/dataprovider，您将看到以下输出。

SQL Data Provider

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',
         ],
      ],
   ]);
   // 返回数据行的数组
   $users = $provider->getModels();
   var_dump($users);
}

步骤 2 − 在 Web 浏览器的地址栏中输入 http://localhost:8080/index.php?r=site/data-provider，您将看到以下输出。

Array 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'],
      ],
   ]);
   // 获取当前请求页面中的行
   $users = $provider->getModels();
   var_dump($users);
}

步骤 2 − 如果您通过 Web 浏览器访问地址 http://localhost:8080/index.php?r=site/data-provider，您将看到以下输出。