YII 类库手册

属性详细

the HTML code representing a filter input (eg a text field, a dropdown list) that is used for this data column. This property is effective only when CGridView::filter is set. If this property is not set, a text field will be generated as the filter input; If this property is an array, a dropdown list will be generated that uses this property value as the list options. If you don't want a filter for this data column, set this value to false.

the attribute name of the data model. Used for column sorting, filtering and to render the corresponding attribute value in each data cell. If value is specified it will be used to rendered the data cell instead of the attribute value.

whether the column is sortable. If so, the header cell will contain a link that may trigger the sorting. Defaults to true. Note that if name is not set, or if name is not allowed by CSort, this property will be treated as false.

the type of the attribute value. This determines how the attribute value is formatted for display. Valid values include those recognizable by CGridView::formatter, such as: raw, text, ntext, html, date, time, datetime, boolean, number, email, image, url. For more details, please refer to CFormatter. Defaults to 'text' which means the attribute value will be HTML-encoded.

a PHP expression that will be evaluated for every data cell and whose result will be rendered as the content of the data cells. In this expression, the variable $row the row number (zero-based); $data the data model for the row; and $this the column object.

方法详细

public function init()
{
    parent::init();
    if($this->name===null)
        $this->sortable=false;
    if($this->name===null && $this->value===null)
        throw new CException(Yii::t('zii','Either "name" or "value" must be specified for CDataColumn.'));
}

Initializes the column.

protected function renderDataCellContent($row,$data)
{
    if($this->value!==null)
        $value=$this->evaluateExpression($this->value,array('data'=>$data,'row'=>$row));
    else if($this->name!==null)
        $value=CHtml::value($data,$this->name);
    echo $value===null ? $this->grid->nullDisplay : $this->grid->getFormatter()->format($value,$this->type);
}

Renders the data cell content. This method evaluates value or name and renders the result.

protected function renderFilterCellContent()
{
    if(is_string($this->filter))
        echo $this->filter;
    else if($this->filter!==false && $this->grid->filter!==null && $this->name!==null && strpos($this->name,'.')===false)
    {
        if(is_array($this->filter))
            echo CHtml::activeDropDownList($this->grid->filter, $this->name, $this->filter, array('id'=>false,'prompt'=>''));
        else if($this->filter===null)
            echo CHtml::activeTextField($this->grid->filter, $this->name, array('id'=>false));
    }
    else
        parent::renderFilterCellContent();
}

Renders the filter cell content. This method will render the filter as is if it is a string. If filter is an array, it is assumed to be a list of options, and a dropdown selector will be rendered. Otherwise if filter is not false, a text field is rendered.

protected function renderHeaderCellContent()
{
    if($this->grid->enableSorting && $this->sortable && $this->name!==null)
        echo $this->grid->dataProvider->getSort()->link($this->name,$this->header);
    else if($this->name!==null && $this->header===null)
    {
        if($this->grid->dataProvider instanceof CActiveDataProvider)
            echo CHtml::encode($this->grid->dataProvider->model->getAttributeLabel($this->name));
        else
            echo CHtml::encode($this->name);
    }
    else
        parent::renderHeaderCellContent();
}

Renders the header cell content. This method will render a link that can trigger the sorting if the column is sortable.