PHP的Yii框架的基本使用示例

这篇文章主要介绍了PHP的Yii框架的基本使用示例,包括触发JS和添加关联表等操作,需要的朋友可以参考下

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

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

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 方法：

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 的代码吧：

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 里面?。。。我说同学，你不会在其他地方写成一个函数然后在这里调用它吗??

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 里面填写，下面是比较常见的使用方式(其他部分代码省略)：

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 :

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

添加 CCheckBoxColumn ：

有时也许我们会需要一个复选框，来对每一行进行选择，这时，我们可以增加一列，用 CCheckBoxColumn 类：

1. <?php $this->widget('zii.widgets.grid.CGridView', array(  
2. 'id'=>'post-grid',  
3. 'dataProvider'=>$model->search(),  
4. 'filter'=>$model,  
5. 'columns'=>array(  
6. array(  
7. 'selectableRows' => 2, //允许多选，改为 0 时代表不允许修改，1 的话为单选  
8. 'class' => 'CCheckBoxColumn',//复选框  
9. 'headerHtmlOptions' => array('width'=>'18px'),//头部的 html 选项  
10. 'checkBoxHtmlOptions' => array('name' => 'myname','class'=>'myclass'), //复选框的 html 选项  
11. ),  
12. 'post_id',  
13. 'title',  
14. 'content',  
15. 'tags',  
16. 'status',  
17. 'create_time',  
18. 'update_time',  
19. 'author_id',  
20. 'is_delete',  
21. array(  
22. 'name'=>'is_delete',  
23. 'value'=>'is_delete?"是":"否"', //value 是可以执行 php 语句的哦  
24. 'filter' => array(0=>'否',1=>'是'), //自己定义搜索过滤的方式，这里为 是 和 否 的下拉菜单  
25. 'htmlOptions'=>array('class'=>'delete'), //可以定义 html 选项，这里是定义了带一个 delete 的类  
26. ),  
27. array(  
28. 'class'=>'CButtonColumn',  
29. ),  
30. ),  
31. ));  

修改ButtonColumn：

注意到列表每一项的最后三个小图标吗?不需要的话当然是直接删了，那要是只要其中某几个呢?可以加一个 template 参数：

1. array(  
2. 'class'=>'ButtonColumn',  
3. 'template'=>"{view} {update}",  
4. ),  

也可以自定义按钮：

1. array(  
2. 'class'=>'ButtonColumn',  
3. 'template'=>"{view} {update} {print}",  
4. 'buttons'=>array(  
5. 'print'=>array(  
6. 'label'=>'打印',  
7. 'url'=>'Yii::app()->controller->createUrl("print", array("id"=>$data->post_id))',  
8. 'options'=>array("target"=>"_blank"),  
9. ),  
10. ),  
11. ),  

刷新时触发 Javascript：

如果你想在每次搜索之后触发一些 Javascript ，Yii 也提供了这个选项，你只要写成一个函数然后设置 afterAjaxUpdate 就好，记住这只是在 ajax 请求完成之后调用的，如果你想在 页面 一开始加载完成就调用的话需要另外加到页面的 Javascript

1. $js = <<<_JS_  
2. function(){  
3. alert('The ajax finish');  
4.  
5. }  
6. _JS_;  
7.  
8. $this->widget('zii.widgets.grid.CGridView', array(  
9. 'id'=>'post-grid',  
10. 'dataProvider'=>$model->search(),  
11. 'filter'=>$model,  
12. 'afterAjaxUpdate'=>$js, //看这里，ajax 之后调用的 javascript 在这里....  
13. 'columns'=>array(  
14. array(  
15. 'selectableRows' => 2, //允许多选，改为 0 时代表不允许修改，1 的话为单选  
16. 'class' => 'CCheckBoxColumn',//复选框  
17. 'headerHtmlOptions' => array('width'=>'18px'),  
18. 'checkBoxHtmlOptions' => array('name' => 'myname','class'=>'myclass'),  
19. ),  
20. ....  

添加 关联表 相关字段的搜索：

先说一句，我们在这里只谈 ”一对多“ 的关联搜索，首先，不要忘了我们的数据库，忘记的同学请戳这里：这里，可以看到在 tbl_post 中是有一个外键关联到 tbl_user 表的，用以查找作者的相关信息。建了数据库之后，看看我们生成的 Yii 代码的 POST 的 Model， 里面的 realtion 如下(忽略 comment 的)：

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. }  

可以看到 POST 和 USER 表可以通过 author 键进行访问，例如: $model->author->nickname,而且 这里是 BELONGS_TO 关系。

说了这么多，我们的需求究竟是什么?....

产品经理推了推眼镜：”我们要在日志的后台管理界面加一个功能，可以通过作者名称搜索到相应的文章。这个比较急，今晚就要完成。“

淡定淡定，不就是改需求吗。忽略进度要求，我们研究一下究竟要做什么。

其实很简单的，不就是在 POST 的 admin 界面中增加一列作者名称，然后可以通过作者名的 模糊搜索 去找到对应日志吗?看看代码，要是通过 作者 id 去搜索不就简单了吗?不过这样确实不太友好...如果是展示作者名字而已不也是很简单吗?加一个 header 然后 value 是 $data->author->username, 问题是这样只能展示，不能进行搜索...哎，好苦恼。

淡定淡定，不就是多个搜索吗?来，让我告诉你怎么做。

首先，我们进入 POST 的 model,在一开始的地方添加一个属性：

1. class Post extends CActiveRecord  
2. {  
3. public $name; //添加一个 public 属性，代表作者名  
4. 然后改一下 Model 里面 search 的代码，改动部分都已经加了注释： 
5.  
6. public function search()  
7. {  
8. // @todo Please modify the following code to remove attributes that should not be searched.  
9.  
10. $criteria=new CDbCriteria;  
11.  
12. $criteria->with = array('author'); //添加了和 author 的渴求式加载  
13.  
14. $criteria->compare('post_id',$this->post_id);  
15. $criteria->compare('title',$this->title,true);  
16. $criteria->compare('content',$this->content,true);  
17. $criteria->compare('tags',$this->tags,true);  
18. $criteria->compare('status',$this->status);  
19. $criteria->compare('create_time',$this->create_time);  
20. $criteria->compare('update_time',$this->update_time);  
21. $criteria->compare('author_id',$this->author_id);  
22.  
23. //这里添加了一个 compare, username 是 User 表的字段,$this->name 是我们添加的属性,true 为模糊搜索  
24. $criteria->compare('username',$this->name,true);  
25.  
26. return new CActiveDataProvider($this, array(  
27. 'criteria'=>$criteria,  
28. ));  
29. }  

然后在 view 里面，就是 post 文件夹的 admin.php ，CGridView 改为下面代码：

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. /*下面就是添加的代码啊*/ 
15. array(  
16. 'name'=>'作者名称',  
17. 'value'=>'$data->author->username', //定义展示的 value 值  
18. 'filter'=>CHtml::activeTextField($model,'name'), //添加搜索 filter  
19. ),  
20. array(  
21. 'class'=>'CButtonColumn',  
22. ),  
23. ),  
24. )); ?>  

你是不是发现现在有了搜索框但是不起作用呢?哈哈，所以我们说文章要坚持看到最后。我们要做的最后一步，就是在 rule 里面，把 name 属性加入到安全搜索字段中，要不然会被 Yii 认为是不安全字段而过滤掉的。看，就在下面函数的最后一行，safe 前面多了个 name ....

1. public function rules()  
2. {  
3. // NOTE: you should only define rules for those attributes that  
4. // will receive user inputs.  
5. return array(  
6. array('title, content, status, author_id', 'required'),  
7. array('status, create_time, update_time, author_id', 'numerical', 'integerOnly'=>true),  
8. array('title', 'length', 'max'=>128),  
9. array('tags', 'safe'),  
10. // The following rule is used by search().  
11. // @todo Please remove those attributes that should not be searched.  
12. array('post_id, title, content, tags, status, create_time, update_time, author_id, name', 'safe', 'on'=>'search'),  
13. );  
14. }