CCheckBoxColumn

Подробности свойств

checkBoxHtmlOptions свойство

public array $checkBoxHtmlOptions;

параметры HTML для чекбоксов.

checked свойство (доступно с версии v1.1.4)

public string $checked;

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

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

disabled свойство (доступно с версии v1.1.13)

public string $disabled;

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

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

footerHtmlOptions свойство

public array $footerHtmlOptions;

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

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

public string getHeaderCellContent()

Возвращает содержимое ячейки заголовка. Этот метод отобразит флажок в заголовке, когда selectableRows больше 1 или в случае, когда selectableRows равно null, а CGridView::selectableRows больше 1.

headerHtmlOptions свойство

public array $headerHtmlOptions;

параметры HTML для тега ячейки заголовка.

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

public string $headerTemplate;

шаблон, используемый для управления представлением ячейки заголовка. Токен "{item}" распознаётся и заменяется на чекбокс «Выбрать все». По умолчанию, в режиме множественного выбора, ячейка заголовка отображает дополнительный чекбокс, нажатие на который устанавливает или снимает отметку со всех чекбоксов в ячейках данных. Подробнее см. selectableRows.

htmlOptions свойство

public array $htmlOptions;

HTML-параметры тегов ячейки данных.

name свойство

public string $name;

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

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

public integer $selectableRows;

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

• 0 — состояние чекбокса нельзя изменить (только чтение)
• 1 — может быть выбрана только одна строка. Установка отметки в чекбоксе не влияет на выбор строки
• 2 или более — можно выбрать несколько чекбоксов. Установка отметки в чекбоксе не влияет на выбор строки
• null — используется CGridView::selectableRows для управления количеством выбираемых чекбоксов. Установка отметки в чекбоксе также выберет строку.

value свойство

public string $value;

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

• $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);
    else
        $value=$this->grid->dataProvider->keys[$row];

    $checked = false;
    if($this->checked!==null)
        $checked=$this->evaluateExpression($this->checked,array('data'=>$data,'row'=>$row));

    $options=$this->checkBoxHtmlOptions;
    if($this->disabled!==null)
        $options['disabled']=$this->evaluateExpression($this->disabled,array('data'=>$data,'row'=>$row));

    $name=$options['name'];
    unset($options['name']);
    $options['value']=$value;
    $options['id']=$this->id.'_'.$row;
    return CHtml::checkBox($name,$checked,$options);
}

Возвращает содержимое ячейки данных. Данный метод отображает чекбокс в ячейке данных.

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

public string getHeaderCellContent()

public function getHeaderCellContent()
{
    if(trim($this->headerTemplate)==='')
        return $this->grid->blankDisplay;

    if($this->selectableRows===null && $this->grid->selectableRows>1)
        $item=CHtml::checkBox($this->id.'_all',false,array('class'=>'select-on-check-all'));
    elseif($this->selectableRows>1)
        $item=CHtml::checkBox($this->id.'_all',false);
    else
        $item=parent::getHeaderCellContent();

    return strtr($this->headerTemplate,array(
        '{item}'=>$item,
    ));
}

Возвращает содержимое ячейки заголовка. Этот метод отобразит чекбокс в заголовке, когда selectableRows больше 1 или в случае, когда selectableRows равно null, а CGridView::selectableRows больше 1.

init() метод

public void init()

public function init()
{
    if(isset($this->checkBoxHtmlOptions['name']))
        $name=$this->checkBoxHtmlOptions['name'];
    else
    {
        $name=$this->id;
        if(substr($name,-2)!=='[]')
            $name.='[]';
        $this->checkBoxHtmlOptions['name']=$name;
    }
    $name=strtr($name,array('['=>"\\[",']'=>"\\]"));

    if($this->selectableRows===null)
    {
        if(isset($this->checkBoxHtmlOptions['class']))
            $this->checkBoxHtmlOptions['class'].=' select-on-check';
        else
            $this->checkBoxHtmlOptions['class']='select-on-check';
        return;
    }

    $cball=$cbcode='';
    if($this->selectableRows==0)
    {
        //.. read only
        $cbcode="return false;";
    }
    elseif($this->selectableRows==1)
    {
        //.. only one can be checked, uncheck all other
        $cbcode="jQuery(\"input:not(#\"+this.id+\")[name='$name']\").prop('checked',false);";
    }
    elseif(strpos($this->headerTemplate,'{item}')!==false)
    {
        //.. process check/uncheck all
        $cball=<<<CBALL
jQuery(document).on('click','#{$this->id}_all',function() {
var checked=this.checked;
jQuery("input[name='$name']:enabled").each(function() {this.checked=checked;});
});

CBALL;
        $cbcode="jQuery('#{$this->id}_all').prop('checked', jQuery(\"input[name='$name']\").length==jQuery(\"input[name='$name']:checked\").length);";
    }

    if($cbcode!=='')
    {
        $js=$cball;
        $js.=<<<EOD
jQuery(document).on('click', "input[name='$name']", function() {
$cbcode
});
EOD;
        Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$this->id,$js);
    }
}

Инициализирует столбец. Этот метод регистрирует необходимый клиентский скрипт для столбца чекбоксов.