CCheckBoxColumn

Property Details

checkBoxHtmlOptions property

public array $checkBoxHtmlOptions;

the HTML options for the checkboxes.

checked property (available since v1.1.4)

public string $checked;

a PHP expression that will be evaluated for every data cell and whose result will determine if checkbox for each data cell is checked. 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

disabled property (available since v1.1.13)

public string $disabled;

a PHP expression that will be evaluated for every data cell and whose result will determine if checkbox for each data cell is disabled. 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

footerHtmlOptions property

public array $footerHtmlOptions;

the HTML options for the footer cell tag.

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

public string getHeaderCellContent()

Returns the header cell content. This method will render a checkbox in the header when selectableRows is greater than 1 or in case selectableRows is null when CGridView::selectableRows is greater than 1.

headerHtmlOptions property

public array $headerHtmlOptions;

the HTML options for the header cell tag.

headerTemplate property (available since v1.1.11)

public string $headerTemplate;

the template to be used to control the layout of the header cell. The token "{item}" is recognized and it will be replaced with a "check all" checkbox. By default if in multiple checking mode, the header cell will display an additional checkbox, clicking on which will check or uncheck all of the checkboxes in the data cells. See selectableRows for more details.

htmlOptions property

public array $htmlOptions;

the HTML options for the data cell tags.

name property

public string $name;

the attribute name of the data model. The corresponding attribute value will be rendered in each data cell as the checkbox value. Note that if value is specified, this property will be ignored.

selectableRows property (available since v1.1.6)

public integer $selectableRows;

the number of rows that can be checked. Possible values:

• 0 - the state of the checkbox cannot be changed (read-only mode)
• 1 - only one row can be checked. Checking a checkbox has nothing to do with selecting the row
• 2 or more - multiple checkboxes can be checked. Checking a checkbox has nothing to do with selecting the row
• null - CGridView::selectableRows is used to control how many checkboxes can be checked. Checking a checkbox will also select the row.

value property

public string $value;

a PHP expression that will be evaluated for every data cell and whose result will be rendered in each data cell as the checkbox value. 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);
    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);
}

Returns the data cell content. This method renders a checkbox in the data cell.

getHeaderCellContent() method (available since 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,
    ));
}

Returns the header cell content. This method will render a checkbox in the header when selectableRows is greater than 1 or in case selectableRows is null when CGridView::selectableRows is greater than 1.

init() method

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

Initializes the column. This method registers necessary client script for the checkbox column.