Yii CGridView 基本使用（一）初展身手

  在 Yii 自动生成的代码里，我们总能在 admin 的界面看到 CGridView 的身影。这是一个很好用的展示数据的表格控件，用的好可以明显地加快开发进度。下面就让我们来探索一下 CGridView 的基本使用吧：

     简单起见，我们的代码就用 Yii demo 中的 blog 例子来做修改。首先，这是修改后的部分 Mysql 语句：

[sql]  view plain  copy

1. drop table if exists `tbl_user`;  
2. CREATE TABLE tbl_user  
3. (  
4.     `user_id` INTEGER NOT NULL AUTO_INCREMENT comment '主键',  
5.     `username` VARCHAR(128) NOT NULL comment '用户名',  
6.     `nickname` VARCHAR(128) NOT NULL comment '昵称',  
7.     `password` VARCHAR(128) NOT NULL comment '密码',  
8.     `email` VARCHAR(128) NOT NULL comment '邮箱',  
9.     `is_delete` tinyint not null default 0 comment '删除标志',  
10.     unique key(`username`),  
11.     primary key (`user_id`)  
12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 comment='用户表';  
13.   
14. drop table if exists `tbl_post`;  
15. CREATE TABLE tbl_post  
16. (  
17.     `post_id` INTEGER NOT NULL AUTO_INCREMENT comment '主键',  
18.     `title` VARCHAR(128) NOT NULL comment '标题',  
19.     `content` TEXT NOT NULL comment '文章内容',  
20.     `tags` TEXT comment '标签',  
21.     `status` INTEGER NOT NULL comment '状态，0 = 草稿，1 = 审核通过，-1 = 审核不通过，2 = 发布',  
22.     `create_time` INTEGER comment '创建时间',  
23.     `update_time` INTEGER comment '更新时间',  
24.     `author_id` INTEGER NOT NULL comment '作者',  
25.     `is_delete` tinyint not null default 0 comment '删除标志',  
26.     CONSTRAINT `post_ibfk_1` FOREIGN KEY (author_id)  
27.         REFERENCES tbl_user (`user_id`) ON DELETE CASCADE ON UPDATE RESTRICT,  
28.     primary key (`post_id`)  
29. ) ENGINE=InnoDB DEFAULT CHARSET=utf8 comment='日志表';  

    两个表一个存储作者信息一个存储日志，其中日志有一个外键关联到 user。两个表里面的 is_delete 字段是标志该条记录是否被删除，0 为未删除，1 为已删除。让我们看一下用 gii 生成的 Post 类的 relation 方法：

[php]  view plain  copy

1. /** 
2.  * @return array relational rules. 
3.  */  
4. public function relations()  
5. {  
6.     // NOTE: you may need to adjust the relation name and the related  
7.     // class name for the relations automatically generated below.  
8.     return array(  
9.         'comments' => array(self::HAS_MANY, 'Comment', 'post_id'),  
10.         'author' => array(self::BELONGS_TO, 'User', 'author_id'),  
11.     );  
12. }  

    其中的 author 外键作为 BELONGS_TO 关系存在，符合我们的预期。

    说了这么多，看看自动生成的 Post 中 admin.php 里 CGridView 的代码吧：

[php]  view plain  copy

1. <?php $this->widget('zii.widgets.grid.CGridView', array(  
2.     'id'=>'post-grid',  
3.     'dataProvider'=>$model->search(),  
4.     'filter'=>$model,  
5.     'columns'=>array(  
6.         'post_id',  
7.         'title',  
8.         'content',  
9.         'tags',  
10.         'status',  
11.         'create_time',  
12.         'update_time',  
13.         'author_id',  
14.         'is_delete',  
15.         array(  
16.             'class'=>'CButtonColumn',  
17.         ),  
18.     ),  
19. )); ?>  

    看！虽然我们什么都没写，但这就是这个控件的最基础使用了。dataProvider 是由 model 里面的 search 函数提供的数据，filter...暂时看不出这里的作用，columns 控制展示的每一列，其中最后一项的 CButtonColumn 向我们展示了三个按钮，分别是 查看  更新 和 删除。

    接下来我们一点点地改造.

用 CGridView 展示我们真正要的数据形式：

    很多时候，数据库里的东西不适合直接展示给用户看，需要我们进行一定的处理之后才适合阅读。但在这里不经修改的话 CGridView 只会把数据库的值原封不动地呈现，所以，我们应该在相应的字段进行修改。比如 is_delete 字段，数据库里存放的是 0 和 1，但是在这里阅读就不太好了，我们应该改成 1 展示 '是' ，0展示 '否'。看看下面的代码，我们用了一个 array,两个键分别是 name 和 value，name 对应的要填写该 model 拥有的字段，而 value 是你想展示的数据，这里可以写成一个 php 语句，作为可以执行的代码。看到这里，是不是觉得对这个 value 我们可以做很多东西？有的同学可能要问，如果我想执行的代码很长，难道都写在 value 里面？。。。我说同学，你不会在其他地方写成一个函数然后在这里调用它吗？？

[php]  view plain  copy

1. <?php $this->widget('zii.widgets.grid.CGridView', array(  
2.     'id'=>'post-grid',  
3.     'dataProvider'=>$model->search(),  
4.     'filter'=>$model,  
5.     'columns'=>array(  
6.         'post_id',  
7.         'title',  
8.         'content',  
9.         'tags',  
10.         'status',  
11.         'create_time',  
12.         'update_time',  
13.         'author_id',  
14.         'is_delete',  
15.         array(  
16.             'name'=>'is_delete',  
17.             'value'=>'is_delete?"是":"否"' //value 是可以执行 php 语句的哦  
18.         )  
19.         array(  
20.             'class'=>'CButtonColumn',  
21.         ),  
22.     ),  
23. )); ?>  

     除此之外，还有一些常用的选项，都可以在 array 里面填写，下面是比较常见的使用方式（其他部分代码省略）：

[php]  view plain  copy

1. array(  
2.     'name'=>'is_delete',  
3.     'value'=>'is_delete?"是":"否"' //value 是可以执行 php 语句的哦  
4.     'filter' => array(0=>'否',1=>'是'), //自己定义搜索过滤的方式，这里为 是 和 否 的下拉菜单  
5.     'htmlOptions'=>array('class'=>'delete'),  //可以定义 html 选项，这里是定义了带一个 delete 的类  
6. ),  

     上面我们用 name 的话那是 model 里原来就有的字段，如果我们想展示自己定义的新内容呢，用 header :

[php]  view plain  copy

1. array(  
2.     'header'=>'备注',  
3.     'value'=> 'display your data'  
4. ),