CDataColumn

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

filter свойство (доступно начиная с v1.1.1)

public mixed $filter;

HTML-код, представляющий поле ввода фильтра (например, текстовое поле, раскрывающийся список), используемый для этого столбца данных. Это свойство эффективно только при установке CGridView::filter. Если это свойство не задано, будет сгенерировано текстовое поле; Если это свойство является массивом, будет сгенерирован раскрывающийся список, который использует это значение свойства в качестве списка вариантов. Если вы не хотите фильтра для этого столбца данных, установите это значение в false.

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

public string getFilterCellContent()

Возвращает содержимое ячейки фильтра. Этот метод вернет filter как есть, если это строка. Если filter является массивом, предполагается, что это список опций, и будет отображен выпадающий список. В противном случае, если filter не равно false, отображается текстовое поле.

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

public string getHeaderCellContent()

Возвращает содержимое ячейки заголовка. Этот метод отобразит ссылку, которая может инициировать сортировку, если столбец сортируемый.

name свойство

public string $name;

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

sortable свойство

public boolean $sortable;

Определяет, сортируется ли столбец. Если да, то ячейка заголовка будет содержать ссылку, которая может инициировать сортировку. По умолчанию true. Обратите внимание, что если name не задано или name не разрешено CSort, это свойство будет считаться false.

type свойство

public string $type;

тип значения атрибута. Это определяет, как значение атрибута форматируется для отображения. Допустимые значения включают те, которые распознаются CGridView::formatter, такие как: raw, text, ntext, html, date, time, datetime, boolean, number, email, image, url. Для получения более подробной информации см. CFormatter. По умолчанию используется 'text', что означает, что значение атрибута будет закодировано в HTML.

значение свойство

public string $value;

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

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

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

getDataCellContent() метод (доступен начиная с версии 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);
}

Возвращает содержимое ячейки данных. Этот метод вычисляет value или name и отображает результат.

getFilterCellContent() метод (доступен начиная с версии 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();
}

Возвращает содержимое ячейки фильтра. Этот метод вернёт значение filter как есть, если оно является строкой. Если filter является массивом, предполагается, что это список опций, и будет отображён выпадающий список. В противном случае, если filter не равно false, отобразится текстовое поле.

getHeaderCellContent() метод (доступен начиная с версии 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();
}

Возвращает содержимое ячейки заголовка. Этот метод отобразит ссылку, которая может инициировать сортировку, если столбец сортируемый.

init() метод

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

Инициализирует столбец.