12.6.5 用户列表-Yii2框架从入门到精通(中)

当前位置:　首页>> 技术小册>> Yii2框架从入门到精通(中)

12.6.5 用户列表

在Web应用程序中，用户管理是一个核心功能，它涵盖了用户的创建、更新、删除以及查看等操作。其中，用户列表页面（User List）是管理员或特定权限用户查看系统中所有用户信息的界面，对于维护系统的用户数据至关重要。在Yii2框架中，实现一个高效、可维护的用户列表页面，不仅需要良好的数据库设计，还需要利用Yii2的MVC（Model-View-Controller）架构、ActiveRecord模式、以及可能的GridView或ListView等组件来优化展示。

12.6.5.1 数据库设计

在构建用户列表之前，确保你的数据库中有合适的用户表。通常，用户表（假设表名为user）会包含以下基本字段：

id：用户唯一标识符，通常为主键，自增。
username：用户名，用于登录。
email：用户的电子邮件地址。
password_hash：用户密码的加密哈希值。
status：用户状态，如激活、未激活、禁用等。
created_at：用户创建时间。
updated_at：用户信息最后更新时间。

此外，根据应用需求，还可能包括更多字段，如姓名、电话、地址等个人信息。

12.6.5.2 模型（Model）

在Yii2中，每个数据库表对应一个模型类，用于表示和操作表中的数据。对于用户表，你需要创建一个User模型类，通常位于models目录下。这个模型类应该继承自\yii\db\ActiveRecord，以便利用ActiveRecord模式提供的方法如find(), save(), delete()等。

namespace app\models;
use Yii;
use yii\db\ActiveRecord;
class User extends ActiveRecord
{
    /**
     * @return \yii\db\ActiveQuery
     */
    public static function tableName()
    {
        return '{{%user}}'; // 使用表前缀时需注意
    }
    // 其他规则、场景定义等
}

12.6.5.3 控制器（Controller）

控制器负责处理用户请求并调用模型与视图来展示数据。对于用户列表，你需要在相应的控制器（比如UserController）中创建一个动作（action），比如index，用于渲染用户列表页面。

namespace app\controllers;
use Yii;
use yii\web\Controller;
use app\models\User;
class UserController extends Controller
{
    public function actionIndex()
    {
        $searchModel = new User();
        $dataProvider = $searchModel->search(Yii::$app->request->queryParams);
        return $this->render('index', [
            'searchModel' => $searchModel,
            'dataProvider' => $dataProvider,
        ]);
    }
}

注意，这里假设User模型实现了搜索功能（通过search方法），该方法通常用于处理查询参数，构建查询条件，并返回一个ActiveDataProvider实例，后者被用于在视图中展示数据。

12.6.5.4 视图（View）

视图层负责数据的展示。对于用户列表，你可以使用Yii2的GridView组件来高效展示用户数据。GridView提供了丰富的配置选项，如分页、排序、过滤等，非常适合用于展示列表数据。

在views/user/index.php文件中，你可以这样使用GridView：

use yii\grid\GridView;
use yii\helpers\Html;
/* @var $this yii\web\View */
/* @var $searchModel app\models\User */
/* @var $dataProvider yii\data\ActiveDataProvider */
$this->title = '用户列表';
$this->params['breadcrumbs'][] = $this->title;
?>
<div class="user-index">
    <h1><?= Html::encode($this->title) ?></h1>
    <?php // echo $this->render('_search', ['model' => $searchModel]); ?>
    <?= GridView::widget([
        'dataProvider' => $dataProvider,
        'filterModel' => $searchModel,
        'columns' => [
            ['class' => 'yii\grid\SerialColumn'],
            'id',
            'username',
            'email:email',
            [
                'attribute' => 'status',
                'value' => function ($model) {
                    return $model->getStatusLabel(); // 假设User模型中有getStatusLabel()方法
                },
                'filter' => \app\models\User::getStatuses(), // 假设User模型中有getStatuses()方法返回状态数组
            ],
            'created_at:datetime',
            ['class' => 'yii\grid\ActionColumn',
                'template' => '{view} {update} {delete}',
                'buttons' => [
                    'view' => function ($url, $model, $key) {
                        return Html::a('<span class="glyphicon glyphicon-eye-open"></span>', $url, [
                            'title' => Yii::t('app', 'View'),
                        ]);
                    },
                    // ... 其他按钮定义
                ],
            ],
        ],
    ]); ?>
</div>

在这个视图中，我们定义了GridView的dataProvider和filterModel，分别用于数据展示和过滤。columns数组定义了每一列的显示内容，包括ID、用户名、邮箱、状态（通过自定义函数和过滤器显示），以及创建时间。同时，我们还使用了ActionColumn来添加操作按钮，如查看、更新和删除用户。