CDataColumn

Property Details

filter property (available since v1.1.1)

public mixed $filter;

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.

filterCellContent property read-only (available since v1.1.16)

public string getFilterCellContent()

Returns the filter cell content. This method will return 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.

headerCellContent property read-only (available since v1.1.16)

public string getHeaderCellContent()

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

name property

public string $name;

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.

sortable property

public boolean $sortable;

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.

type property

public string $type;

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.

value property

public string $value;

a PHP expression that will be evaluated for every data cell using evaluateExpression and whose result will be rendered as the content of the data cell. In this expression, you can use the following variables:

• $row the row number (zero-based).
• $data the data model for the row.
• $this the column object.

Method Details

getDataCellContent() method (available since v1.1.16)

public string getDataCellContent(integer $row)

public function getDataCellContent($row)
{
    $data=$this->grid->dataProvider->data[$row];
    if($this->value!==null)
        $value=$this->evaluateExpression($this->value,array('data'=>$data,'row'=>$row));
    elseif($this->name!==null)
        $value=CHtml::value($data,$this->name);
    return $value===null ? $this->grid->nullDisplay : $this->grid->getFormatter()->format($value,$this->type);
}

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

getFilterCellContent() method (available since v1.1.16)

public string getFilterCellContent()

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

Returns the filter cell content. This method will return 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.

getHeaderCellContent() method (available since v1.1.16)

public string getHeaderCellContent()

public function getHeaderCellContent()
{
    if($this->grid->enableSorting && $this->sortable && $this->name!==null)
        return $this->grid->dataProvider->getSort()->link($this->name,$this->header,array('class'=>'sort-link'));
    elseif($this->name!==null && $this->header===null)
    {
        if($this->grid->dataProvider instanceof CActiveDataProvider)
            return CHtml::encode($this->grid->dataProvider->model->getAttributeLabel($this->name));
        else
            return CHtml::encode($this->name);
    }
    else
        return parent::getHeaderCellContent();
}

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

init() method

public void init()

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.