CGridColumn

Property Details

cssClassExpression property

public string $cssClassExpression;

a PHP expression that is evaluated for every data cell and whose result is used as the CSS class name for 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

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

public string getFilterCellContent()

Returns the filter cell content. The default implementation simply returns an empty column. This method may be overridden to customize the rendering of the filter cell (if any).

filterHtmlOptions property

public array $filterHtmlOptions;

the HTML options for the filter cell tag.

footer property

public string $footer;

the footer cell text. Note that it will not be HTML-encoded.

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

public string getFooterCellContent()

Returns the footer cell content. The default implementation simply returns footer. This method may be overridden to customize the rendering of the footer cell.

footerHtmlOptions property

public array $footerHtmlOptions;

the HTML options for the footer cell tag.

grid property

public CGridView $grid;

the grid view object that owns this column.

hasFooter property read-only

public boolean getHasFooter()

whether this column has a footer cell. This is determined based on whether footer is set.

header property

public string $header;

the header cell text. Note that it will not be HTML-encoded.

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

public string getHeaderCellContent()

Returns the header cell content. The default implementation simply returns header. This method may be overridden to customize the rendering of the header cell.

headerHtmlOptions property

public array $headerHtmlOptions;

the HTML options for the header cell tag.

htmlOptions property

public array $htmlOptions;

the HTML options for the data cell tags.

id property

public string $id;

the ID of this column. This value should be unique among all grid view columns. If this is not set, it will be assigned one automatically.

visible property

public boolean $visible;

whether this column is visible. Defaults to true.

Method Details

__construct() method

public void __construct(CGridView $grid)

public function __construct($grid)
{
    $this->grid=$grid;
}

Constructor.

getDataCellContent() method (available since v1.1.16)

public string getDataCellContent(integer $row)

public function getDataCellContent($row)
{
    return $this->grid->blankDisplay;
}

Returns the data cell content. This method SHOULD be overridden to customize the rendering of the data cell.

getFilterCellContent() method (available since v1.1.16)

public string getFilterCellContent()

public function getFilterCellContent()
{
    return $this->grid->blankDisplay;
}

Returns the filter cell content. The default implementation simply returns an empty column. This method may be overridden to customize the rendering of the filter cell (if any).

getFooterCellContent() method (available since v1.1.16)

public string getFooterCellContent()

public function getFooterCellContent()
{
    return trim($this->footer)!=='' ? $this->footer : $this->grid->blankDisplay;
}

Returns the footer cell content. The default implementation simply returns footer. This method may be overridden to customize the rendering of the footer cell.

getHasFooter() method

public boolean getHasFooter()

public function getHasFooter()
{
    return $this->footer!==null;
}

getHeaderCellContent() method (available since v1.1.16)

public string getHeaderCellContent()

public function getHeaderCellContent()
{
    return trim($this->header)!=='' ? $this->header : $this->grid->blankDisplay;
}

Returns the header cell content. The default implementation simply returns header. This method may be overridden to customize the rendering of the header cell.

init() method

public void init()

public function init()
{
}

Initializes the column. This method is invoked by the grid view when it initializes itself before rendering. You may override this method to prepare the column for rendering.

renderDataCell() method

public void renderDataCell(integer $row)

public function renderDataCell($row)
{
    $data=$this->grid->dataProvider->data[$row];
    $options=$this->htmlOptions;
    if($this->cssClassExpression!==null)
    {
        $class=$this->evaluateExpression($this->cssClassExpression,array('row'=>$row,'data'=>$data));
        if(!empty($class))
        {
            if(isset($options['class']))
                $options['class'].=' '.$class;
            else
                $options['class']=$class;
        }
    }
    echo CHtml::openTag('td',$options);
    $this->renderDataCellContent($row,$data);
    echo '</td>';
}

Renders a data cell.

renderDataCellContent() method

protected void renderDataCellContent(integer $row, mixed $data)

protected function renderDataCellContent($row,$data)
{
    echo $this->getDataCellContent($row);
}

Renders the data cell content.

renderFilterCell() method (available since v1.1.1)

public void renderFilterCell()

public function renderFilterCell()
{
    echo CHtml::openTag('td',$this->filterHtmlOptions);
    $this->renderFilterCellContent();
    echo "</td>";
}

Renders the filter cell.

renderFilterCellContent() method (available since v1.1.1)

protected void renderFilterCellContent()

protected function renderFilterCellContent()
{
    echo $this->getFilterCellContent();
}

Renders the filter cell content.

renderFooterCell() method

public void renderFooterCell()

public function renderFooterCell()
{
    echo CHtml::openTag('td',$this->footerHtmlOptions);
    $this->renderFooterCellContent();
    echo '</td>';
}

Renders the footer cell.

renderFooterCellContent() method

protected void renderFooterCellContent()

protected function renderFooterCellContent()
{
    echo $this->getFooterCellContent();
}

Renders the footer cell content.

renderHeaderCell() method

public void renderHeaderCell()

public function renderHeaderCell()
{
    $this->headerHtmlOptions['id']=$this->id;
    echo CHtml::openTag('th',$this->headerHtmlOptions);
    $this->renderHeaderCellContent();
    echo "</th>";
}

Renders the header cell.

renderHeaderCellContent() method

protected void renderHeaderCellContent()

protected function renderHeaderCellContent()
{
    echo $this->getHeaderCellContent();
}

Renders the header cell content.