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