在 Yii 自動生成的代碼裡，我們總能在 admin 的界面看到 CGridView 的身影。這是一個很好用的展示數據的表格控件，用的好可以明顯地加快開發進度。下面就讓我們來探索一下 CGridView 的基本使用吧：
簡單起見，我們的代碼就用 Yii demo 中的 blog 例子來做修改。首先，這是修改後的部分 Mysql 語句：
drop table if exists `tbl_user`;
CREATE TABLE tbl_user
(
`user_id` INTEGER NOT NULL AUTO_INCREMENT comment '主鍵',
`username` VARCHAR(128) NOT NULL comment '用戶名',
`nickname` VARCHAR(128) NOT NULL comment '昵稱',
`password` VARCHAR(128) NOT NULL comment '密碼',
`email` VARCHAR(128) NOT NULL comment '郵箱',
`is_delete` tinyint not null default 0 comment '刪除標志',
unique key(`username`),
primary key (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 comment='用戶表';
drop table if exists `tbl_post`;
CREATE TABLE tbl_post
(
`post_id` INTEGER NOT NULL AUTO_INCREMENT comment '主鍵',
`title` VARCHAR(128) NOT NULL comment '標題',
`content` TEXT NOT NULL comment '文章內容',
`tags` TEXT comment '標簽',
`status` INTEGER NOT NULL comment '狀態，0 = 草稿，1 = 審核通過，-1 = 審核不通過，2 = 發布',
`create_time` INTEGER comment '創建時間',
`update_time` INTEGER comment '更新時間',
`author_id` INTEGER NOT NULL comment '作者',
`is_delete` tinyint not null default 0 comment '刪除標志',
CONSTRAINT `post_ibfk_1` FOREIGN KEY (author_id)
REFERENCES tbl_user (`user_id`) ON DELETE CASCADE ON UPDATE RESTRICT,
primary key (`post_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 comment='日志表';
兩個表一個存儲作者信息一個存儲日志，其中日志有一個外鍵關聯到 user。兩個表裡面的 is_delete 字段是標志該條記錄是否被刪除，0 為未刪除，1 為已刪除。讓我們看一下用 gii 生成的 Post 類的 relation 方法：
/**
* @return array relational rules.
*/
public function relations()
{
// NOTE: you may need to adjust the relation name and the related
// class name for the relations automatically generated below.
return array(
'comments' => array(self::HAS_MANY, 'Comment', 'post_id'),
'author' => array(self::BELONGS_TO, 'User', 'author_id'),
);
}
其中的 author 外鍵作為 BELONGS_TO 關系存在，符合我們的預期。
說了這麼多，看看自動生成的 Post 中 admin.php 裡 CGridView 的代碼吧：
<?php $this->widget('zii.widgets.grid.CGridView', array(
'id'=>'post-grid',
'dataProvider'=>$model->search(),
'filter'=>$model,
'columns'=>array(
'post_id',
'title',
'content',
'tags',
'status',
'create_time',
'update_time',
'author_id',
'is_delete',
array(
'class'=>'CButtonColumn',
),
),
)); ?>
看！雖然我們什麼都沒寫，但這就是這個控件的最基礎使用了。dataProvider 是由 model 裡面的 search 函數提供的數據，filter...暫時看不出這裡的作用，columns 控制展示的每一列，其中最後一項的 CButtonColumn 向我們展示了三個按鈕，分別是 查看 更新 和 刪除。
接下來我們一點點地改造.
用 CGridView 展示我們真正要的數據形式：
很多時候，數據庫裡的東西不適合直接展示給用戶看，需要我們進行一定的處理之後才適合閱讀。但在這裡不經修改的話 CGridView 只會把數據庫的值原封不動地呈現，所以，我們應該在相應的字段進行修改。比如 is_delete 字段，數據庫裡存放的是 0 和 1，但是在這裡閱讀就不太好了，我們應該改成 1 展示 '是' ，0展示 '否'。看看下面的代碼，我們用了一個 array,兩個鍵分別是 name 和 value，name 對應的要填寫該 model 擁有的字段，而 value 是你想展示的數據，這裡可以寫成一個 php 語句，作為可以執行的代碼。看到這裡，是不是覺得對這個 value 我們可以做很多東西？有的同學可能要問，如果我想執行的代碼很長，難道都寫在 value 裡面？。。。我說同學，你不會在其他地方寫成一個函數然後在這裡調用它嗎？？
<?php $this->widget('zii.widgets.grid.CGridView', array(
'id'=>'post-grid',
'dataProvider'=>$model->search(),
'filter'=>$model,
'columns'=>array(
'post_id',
'title',
'content',
'tags',
'status',
'create_time',
'update_time',
'author_id',
'is_delete',
array(
'name'=>'is_delete',
'value'=>'is_delete?"是":"否"' //value 是可以執行 php 語句的哦
)
array(
'class'=>'CButtonColumn',
),
),
)); ?>
除此之外，還有一些常用的選項，都可以在 array 裡面填寫，下面是比較常見的使用方式（其他部分代碼省略）：
array(
'name'=>'is_delete',
'value'=>'is_delete?"是":"否"' //value 是可以執行 php 語句的哦
'filter' => array(0=>'否',1=>'是'), //自己定義搜索過濾的方式，這裡為 是 和 否 的下拉菜單
'htmlOptions'=>array('class'=>'delete'), //可以定義 html 選項，這裡是定義了帶一個 delete 的類
),
上面我們用 name 的話那是 model 裡原來就有的字段，如果我們想展示自己定義的新內容呢，用 header :
array( 'header'=>'備注', 'value'=> 'display your data' ),
添加 CCheckBoxColumn ：
有時也許我們會需要一個復選框，來對每一行進行選擇，這時，我們可以增加一列，用 CCheckBoxColumn 類：
<?php $this->widget('zii.widgets.grid.CGridView', array(
'id'=>'post-grid',
'dataProvider'=>$model->search(),
'filter'=>$model,
'columns'=>array(
array(
'selectableRows' => 2, //允許多選，改為 0 時代表不允許修改，1 的話為單選
'class' => 'CCheckBoxColumn',//復選框
'headerHtmlOptions' => array('width'=>'18px'),//頭部的 html 選項
'checkBoxHtmlOptions' => array('name' => 'myname','class'=>'myclass'), //復選框的 html 選項
),
'post_id',
'title',
'content',
'tags',
'status',
'create_time',
'update_time',
'author_id',
'is_delete',
array(
'name'=>'is_delete',
'value'=>'is_delete?"是":"否"', //value 是可以執行 php 語句的哦
'filter' => array(0=>'否',1=>'是'), //自己定義搜索過濾的方式，這裡為 是 和 否 的下拉菜單
'htmlOptions'=>array('class'=>'delete'), //可以定義 html 選項，這裡是定義了帶一個 delete 的類
),
array(
'class'=>'CButtonColumn',
),
),
));
修改ButtonColumn：
注意到列表每一項的最後三個小圖標嗎？不需要的話當然是直接刪了，那要是只要其中某幾個呢？可以加一個 template 參數：
array(
'class'=>'ButtonColumn',
'template'=>"{view} {update}",
),
也可以自定義按鈕：
array(
'class'=>'ButtonColumn',
'template'=>"{view} {update} {print}",
'buttons'=>array(
'print'=>array(
'label'=>'打印',
'url'=>'Yii::app()->controller->createUrl("print", array("id"=>$data->post_id))',
'options'=>array("target"=>"_blank"),
),
),
),
刷新時觸發 Javascript：
如果你想在每次搜索之後觸發一些 Javascript ，Yii 也提供了這個選項，你只要寫成一個函數然後設置 afterAjaxUpdate 就好，記住這只是在 ajax 請求完成之後調用的，如果你想在 頁面 一開始加載完成就調用的話需要另外加到頁面的 Javascript
$js = <<<_JS_
function(){
alert('The ajax finish');
}
_JS_;
$this->widget('zii.widgets.grid.CGridView', array(
'id'=>'post-grid',
'dataProvider'=>$model->search(),
'filter'=>$model,
'afterAjaxUpdate'=>$js, //看這裡，ajax 之後調用的 javascript 在這裡....
'columns'=>array(
array(
'selectableRows' => 2, //允許多選，改為 0 時代表不允許修改，1 的話為單選
'class' => 'CCheckBoxColumn',//復選框
'headerHtmlOptions' => array('width'=>'18px'),
'checkBoxHtmlOptions' => array('name' => 'myname','class'=>'myclass'),
),
....
添加 關聯表 相關字段的搜索：
先說一句，我們在這裡只談 ”一對多“ 的關聯搜索，首先，不要忘了我們的數據庫，忘記的同學請戳這裡：這裡，可以看到在 tbl_post 中是有一個外鍵關聯到 tbl_user 表的，用以查找作者的相關信息。建了數據庫之後，看看我們生成的 Yii 代碼的 POST 的 Model， 裡面的 realtion 如下（忽略 comment 的）：
/**
* @return array relational rules.
*/
public function relations()
{
// NOTE: you may need to adjust the relation name and the related
// class name for the relations automatically generated below.
return array(
'comments' => array(self::HAS_MANY, 'Comment', 'post_id'),
'author' => array(self::BELONGS_TO, 'User', 'author_id'),
);
}
可以看到 POST 和 USER 表可以通過 author 鍵進行訪問，例如: $model->author->nickname,而且 這裡是 BELONGS_TO 關系。
說了這麼多，我們的需求究竟是什麼？....
產品經理推了推眼鏡：”我們要在日志的後台管理界面加一個功能，可以通過作者名稱搜索到相應的文章。這個比較急，今晚就要完成。“
淡定淡定，不就是改需求嗎。忽略進度要求，我們研究一下究竟要做什麼。
其實很簡單的，不就是在 POST 的 admin 界面中增加一列作者名稱，然後可以通過作者名的 模糊搜索 去找到對應日志嗎？看看代碼，要是通過 作者 id 去搜索不就簡單了嗎？不過這樣確實不太友好...如果是展示作者名字而已不也是很簡單嗎？加一個 header 然後 value 是 $data->author->username, 問題是這樣只能展示，不能進行搜索...哎，好苦惱。
淡定淡定，不就是多個搜索嗎？來，讓我告訴你怎麼做。
首先，我們進入 POST 的 model,在一開始的地方添加一個屬性：
class Post extends CActiveRecord
{
public $name; //添加一個 public 屬性，代表作者名
然後改一下 Model 裡面 search 的代碼，改動部分都已經加了注釋：
public function search()
{
// @todo Please modify the following code to remove attributes that should not be searched.
$criteria=new CDbCriteria;
$criteria->with = array('author'); //添加了和 author 的渴求式加載
$criteria->compare('post_id',$this->post_id);
$criteria->compare('title',$this->title,true);
$criteria->compare('content',$this->content,true);
$criteria->compare('tags',$this->tags,true);
$criteria->compare('status',$this->status);
$criteria->compare('create_time',$this->create_time);
$criteria->compare('update_time',$this->update_time);
$criteria->compare('author_id',$this->author_id);
//這裡添加了一個 compare, username 是 User 表的字段,$this->name 是我們添加的屬性,true 為模糊搜索
$criteria->compare('username',$this->name,true);
return new CActiveDataProvider($this, array(
'criteria'=>$criteria,
));
}
然後在 view 裡面，就是 post 文件夾的 admin.php ，CGridView 改為下面代碼：
<?php $this->widget('zii.widgets.grid.CGridView', array(
'id'=>'post-grid',
'dataProvider'=>$model->search(),
'filter'=>$model,
'columns'=>array(
'post_id',
'title',
'content',
'tags',
'status',
'create_time',
'update_time',
'author_id',
/*下面就是添加的代碼啊*/
array(
'name'=>'作者名稱',
'value'=>'$data->author->username', //定義展示的 value 值
'filter'=>CHtml::activeTextField($model,'name'), //添加搜索 filter
),
array(
'class'=>'CButtonColumn',
),
),
)); ?>
你是不是發現現在有了搜索框但是不起作用呢？哈哈，所以我們說文章要堅持看到最後。我們要做的最後一步，就是在 rule 裡面，把 name 屬性加入到安全搜索字段中，要不然會被 Yii 認為是不安全字段而過濾掉的。看，就在下面函數的最後一行，safe 前面多了個 name ....
public function rules()
{
// NOTE: you should only define rules for those attributes that
// will receive user inputs.
return array(
array('title, content, status, author_id', 'required'),
array('status, create_time, update_time, author_id', 'numerical', 'integerOnly'=>true),
array('title', 'length', 'max'=>128),
array('tags', 'safe'),
// The following rule is used by search().
// @todo Please remove those attributes that should not be searched.
array('post_id, title, content, tags, status, create_time, update_time, author_id, name', 'safe', 'on'=>'search'),
);
}
