CGridColumn

Подробное описание свойств

cssClassExpression свойство

public string $cssClassExpression;

PHP-выражение, которое вычисляется для каждой ячейки данных, и результат которого используется в качестве имени класса CSS для ячейки данных. В этом выражении можно использовать следующие переменные:

• $row номер строки (нумерация с нуля)
• $data модель данных для строки
• $this объект столбца

filterCellContent свойство только для чтения (доступно начиная с версии v1.1.16)

public string getFilterCellContent()

Возвращает содержимое ячейки фильтра. По умолчанию возвращается пустой столбец. Этот метод можно переопределить для настройки отображения ячейки фильтра (если она есть).

filterHtmlOptions свойство

public array $filterHtmlOptions;

HTML-атрибуты тега ячейки фильтра.

footer свойство

public string $footer;

Текст ячейки подвала. Обратите внимание, что он не будет HTML-кодирован.

footerCellContent свойство только для чтения (доступно начиная с версии v1.1.16)

public string getFooterCellContent()

Возвращает содержимое ячейки подвала. По умолчанию возвращает footer. Этот метод можно переопределить для настройки отображения ячейки подвала.

footerHtmlOptions свойство

public array $footerHtmlOptions;

HTML-атрибуты тега ячейки подвала.

grid свойство

public CGridView $grid;

Объект представления таблицы, которому принадлежит этот столбец.

hasFooter свойство только для чтения

public boolean getHasFooter()

Признак наличия ячейки подвала у этого столбца. Определяется на основе наличия footer.

header свойство

public string $header;

Текст ячейки заголовка. Обратите внимание, что он не будет HTML-кодирован.

headerCellContent свойство только для чтения (доступно начиная с версии v1.1.16)

public string getHeaderCellContent()

Возвращает содержимое ячейки заголовка. По умолчанию возвращает header. Этот метод можно переопределить для настройки отображения ячейки заголовка.

headerHtmlOptions свойство

public array $headerHtmlOptions;

HTML-атрибуты тега ячейки заголовка.

htmlOptions свойство

public array $htmlOptions;

HTML-атрибуты тегов ячеек данных.

id свойство

public string $id;

Идентификатор этого столбца. Это значение должно быть уникальным среди всех столбцов представления таблицы. Если не задано, будет присвоено автоматически.

visible свойство

public boolean $visible;

Признак видимости этого столбца. По умолчанию true.

Подробное описание методов

__construct() метод

public void __construct(CGridView $grid)

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

Конструктор.

getDataCellContent() метод (доступно начиная с v1.1.16)

public string getDataCellContent(integer $row)

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

Возвращает содержимое ячейки данных. Этот метод ДОЛЖЕН быть переопределен для настройки отображения ячейки данных.

getFilterCellContent() метод (доступно начиная с v1.1.16)

public string getFilterCellContent()

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

Возвращает содержимое ячейки фильтра. По умолчанию возвращается пустой столбец. Этот метод можно переопределить для настройки отображения ячейки фильтра (если она есть).

getFooterCellContent() метод (доступно начиная с v1.1.16)

public string getFooterCellContent()

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

Возвращает содержимое ячейки подвала. По умолчанию возвращает footer. Этот метод можно переопределить для настройки отображения ячейки подвала.

getHasFooter() метод

public boolean getHasFooter()

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

getHeaderCellContent() метод (доступно начиная с v1.1.16)

public string getHeaderCellContent()

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

Возвращает содержимое ячейки заголовка. По умолчанию возвращает header. Этот метод можно переопределить для настройки отображения ячейки заголовка.

init() метод

public void init()

public function init()
{
}

Инициализирует столбец. Вызывается представлением таблицы при инициализации перед отображением. Можно переопределить этот метод для подготовки столбца к отображению.

renderDataCell() метод

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>';
}

Отображает ячейку данных.

renderDataCellContent() метод

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

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

Отображает содержимое ячейки данных.

renderFilterCell() метод (доступен начиная с v1.1.1)

public void renderFilterCell()

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

Отображает ячейку фильтра.

renderFilterCellContent() метод (доступен начиная с v1.1.1)

protected void renderFilterCellContent()

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

Отображает содержимое ячейки фильтра.

renderFooterCell() метод

public void renderFooterCell()

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

Отображает ячейку подвала.

renderFooterCellContent() метод

protected void renderFooterCellContent()

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

Отображает содержимое ячейки подвала.

renderHeaderCell() метод

public void renderHeaderCell()

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

Отображает ячейку заголовка.

renderHeaderCellContent() метод

protected void renderHeaderCellContent()

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

Отображает содержимое ячейки заголовка.