這篇文章主要介紹了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. }