Yii - Sorting

When displaying lots of data, we often need to sort the data. Yii uses an yiidataSort object to represent a sorting schema.

To show sorting in action, we need data.

Preparing the DB

Step 1 − Create a new database. Database can be prepared in the following two ways.

In the terminal run mysql -u root –p

Create a new database via CREATE DATABASE helloworld CHARACTER SET utf8 COLLATE utf8_general_ci;

Step 2 − Configure the database connection in the config/db.php file. The following configuration is for the system used currently.

<?php
   return [
       class  =>  yiidbConnection ,
       dsn  =>  mysql:host=localhost;dbname=helloworld ,
       username  =>  vladimir ,
       password  =>  12345 ,
       charset  =>  utf8 ,
   ];
?>

Step 3 − Inside the root folder run ./yii migrate/create test_table. This command will create a database migration for managing our DB. The migration file should appear in the migrations folder of the project root.

Step 4 − Modify the migration file (m160106_163154_test_table.php in this case) this way.

<?php
   use yiidbSchema;
   use yiidbMigration;
   class m160106_163154_test_table extends Migration {
      pubpc 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"],
         ]);
      }
      pubpc function safeDown() {
         $this->dropTable( user );
      }
   }
?>

The above migration creates a user table with these fields: id, name, and email. It also adds a few demo users.

Step 5 − Inside the project root run ./yii migrate to apply the migration to the database.

Step 6 − Now, we need to create a model for our user table. For the sake of simppcity, we are going to use the Gii code generation tool. Open up this url: http://localhost:8080/index.php?r=gii. Then, cpck the “Start” button under the “Model generator” header. Fill in the Table Name (“user”) and the Model Class(“MyUser”), cpck the “Preview” button and finally, cpck the “Generate” button.

The MyUser model should appear in the models directory.

Sorting in Action

Step 1 − Add an actionSorting method to the SiteController.

pubpc function actionSorting() {
   //declaring the sort object
   $sort = new Sort([
       attributes  => [ id ,  name ,  email ], 
   ]);
   //retrieving all users
   $models = MyUser::find()
      ->orderBy($sort->orders)
      ->all();
   return $this->render( sorting , [
       models  => $models,
       sort  => $sort,
   ]);
}

Step 2 − Create a View file called sorting inside the views/site folder.

<?php
   // display pnks leading to sort actions
   echo $sort->pnk( id ) .   |   . $sort->pnk( name ) .   |   . $sort->pnk( email );
?><br/>
<?php foreach ($models as $model): ?>
   <?= $model->id; ?>
   <?= $model->name; ?>
   <?= $model->email; ?>
   <br/>
<?php endforeach; ?>

Step 3 − Now, if you type http://localhost:8080/index.php?r=site/sorting in the web browser, you can see that the id, name, and email fields is sortable as shown in the following image.