CButtonColumn

Property Details

afterDelete property

public string $afterDelete;

a javascript function that will be invoked after the delete ajax call. This property is used only if $this->buttons['delete']['click'] is not set.

The function signature is function(link, success, data)

• link references the delete link.
• success status of the ajax call, true if the ajax call was successful, false if the ajax call failed.
• data the data returned by the server in case of a successful call or XHR object in case of error.

 array(
    class'=>'CButtonColumn',
    'afterDelete'=>'function(link,success,data){ if(success) alert("Delete completed successfully"); }',
 ),

buttons property

public array $buttons;

the configuration for buttons. Each array element specifies a single button which has the following format:

'buttonID' => array(
    'label'=>'...',     // text label of the button
    'url'=>'...',       // a PHP expression for generating the URL of the button
    'imageUrl'=>'...',  // image URL of the button. If not set or false, a text link is used
    'options'=>array(...), // HTML options for the button tag
    'click'=>'...',     // a JS function to be invoked when the button is clicked
    'visible'=>'...',   // a PHP expression for determining whether the button is visible
)

deleteButtonImageUrl property

public string $deleteButtonImageUrl;

the image URL for the delete button. If not set, an integrated image will be used. You may set this property to be false to render a text link instead.

deleteButtonLabel property

public string $deleteButtonLabel;

the label for the delete button. Defaults to "Delete". Note that the label will not be HTML-encoded when rendering.

deleteButtonOptions property

public array $deleteButtonOptions;

the HTML options for the delete button tag.

deleteButtonUrl property

public string $deleteButtonUrl;

a PHP expression that is evaluated for every delete button and whose result is used as the URL for the delete button. 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

deleteConfirmation property

public string $deleteConfirmation;

the confirmation message to be displayed when delete button is clicked. By setting this property to be false, no confirmation message will be displayed. This property is used only if $this->buttons['delete']['click'] is not set.

footerHtmlOptions property

public array $footerHtmlOptions;

the HTML options for the footer cell tag.

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.

template property

public string $template;

the template that is used to render the content in each data cell. These default tokens are recognized: {view}, {update} and {delete}. If the buttons property defines additional buttons, their IDs are also recognized here. For example, if a button named 'preview' is declared in buttons, we can use the token '{preview}' here to specify where to display the button.

updateButtonImageUrl property

public string $updateButtonImageUrl;

the image URL for the update button. If not set, an integrated image will be used. You may set this property to be false to render a text link instead.

updateButtonLabel property

public string $updateButtonLabel;

the label for the update button. Defaults to "Update". Note that the label will not be HTML-encoded when rendering.

updateButtonOptions property

public array $updateButtonOptions;

the HTML options for the update button tag.

updateButtonUrl property

public string $updateButtonUrl;

a PHP expression that is evaluated for every update button and whose result is used as the URL for the update button. 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

viewButtonImageUrl property

public string $viewButtonImageUrl;

the image URL for the view button. If not set, an integrated image will be used. You may set this property to be false to render a text link instead.

viewButtonLabel property

public string $viewButtonLabel;

the label for the view button. Defaults to "View". Note that the label will not be HTML-encoded when rendering.

viewButtonOptions property

public array $viewButtonOptions;

the HTML options for the view button tag.

viewButtonUrl property

public string $viewButtonUrl;

a PHP expression that is evaluated for every view button and whose result is used as the URL for the view button. 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];
    $tr=array();
    ob_start();
    foreach($this->buttons as $id=>$button)
    {
        $this->renderButton($id,$button,$row,$data);
        $tr['{'.$id.'}']=ob_get_contents();
        ob_clean();
    }
    ob_end_clean();
    return strtr($this->template,$tr);
}

Returns the data cell content. This method renders the view, update and delete buttons in the data cell.

init() method

public void init()

public function init()
{
    $this->initDefaultButtons();

    foreach($this->buttons as $id=>$button)
    {
        if(strpos($this->template,'{'.$id.'}')===false)
            unset($this->buttons[$id]);
        elseif(isset($button['click']))
        {
            if(!isset($button['options']['class']))
                $this->buttons[$id]['options']['class']=$id;
            if(!($button['click'] instanceof CJavaScriptExpression))
                $this->buttons[$id]['click']=new CJavaScriptExpression($button['click']);
        }
    }

    $this->registerClientScript();
}

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

initDefaultButtons() method

protected void initDefaultButtons()

protected function initDefaultButtons()
{
    if($this->viewButtonLabel===null)
        $this->viewButtonLabel=Yii::t('zii','View');
    if($this->updateButtonLabel===null)
        $this->updateButtonLabel=Yii::t('zii','Update');
    if($this->deleteButtonLabel===null)
        $this->deleteButtonLabel=Yii::t('zii','Delete');
    if($this->viewButtonImageUrl===null)
        $this->viewButtonImageUrl=$this->grid->baseScriptUrl.'/view.png';
    if($this->updateButtonImageUrl===null)
        $this->updateButtonImageUrl=$this->grid->baseScriptUrl.'/update.png';
    if($this->deleteButtonImageUrl===null)
        $this->deleteButtonImageUrl=$this->grid->baseScriptUrl.'/delete.png';
    if($this->deleteConfirmation===null)
        $this->deleteConfirmation=Yii::t('zii','Are you sure you want to delete this item?');

    foreach(array('view','update','delete') as $id)
    {
        $button=array(
            'label'=>$this->{$id.'ButtonLabel'},
            'url'=>$this->{$id.'ButtonUrl'},
            'imageUrl'=>$this->{$id.'ButtonImageUrl'},
            'options'=>$this->{$id.'ButtonOptions'},
        );
        if(isset($this->buttons[$id]))
            $this->buttons[$id]=array_merge($button,$this->buttons[$id]);
        else
            $this->buttons[$id]=$button;
    }

    if(!isset($this->buttons['delete']['click']))
    {
        if(is_string($this->deleteConfirmation))
            $confirmation="if(!confirm(".CJavaScript::encode($this->deleteConfirmation).")) return false;";
        else
            $confirmation='';

        if(Yii::app()->request->enableCsrfValidation)
        {
            $csrfTokenName = Yii::app()->request->csrfTokenName;
            $csrfToken = Yii::app()->request->csrfToken;
            $csrf = "\n\t\tdata:{ '$csrfTokenName':'$csrfToken' },";
        }
        else
            $csrf = '';

        if($this->afterDelete===null)
            $this->afterDelete='function(){}';

        $this->buttons['delete']['click']=<<<EOD
function() {
$confirmation
var th = this,
    afterDelete = $this->afterDelete;
jQuery('#{$this->grid->id}').yiiGridView('update', {
    type: 'POST',
    url: jQuery(this).attr('href'),$csrf
    success: function(data) {
        jQuery('#{$this->grid->id}').yiiGridView('update');
        afterDelete(th, true, data);
    },
    error: function(XHR) {
        return afterDelete(th, false, XHR);
    }
});
return false;
}
EOD;
    }
}

Initializes the default buttons (view, update and delete).

registerClientScript() method

protected void registerClientScript()

protected function registerClientScript()
{
    $js=array();
    foreach($this->buttons as $id=>$button)
    {
        if(isset($button['click']))
        {
            $function=CJavaScript::encode($button['click']);
            $class=preg_replace('/\s+/','.',$button['options']['class']);
            $js[]="jQuery(document).on('click','#{$this->grid->id} a.{$class}',$function);";
        }
    }

    if($js!==array())
        Yii::app()->getClientScript()->registerScript(__CLASS__.'#'.$this->id, implode("\n",$js));
}

Registers the client scripts for the button column.

renderButton() method

protected void renderButton(string $id, array $button, integer $row, mixed $data)

protected function renderButton($id,$button,$row,$data)
{
    if (isset($button['visible']) && !$this->evaluateExpression($button['visible'],array('row'=>$row,'data'=>$data)))
          return;
    $label=isset($button['label']) ? $button['label'] : $id;
    $url=isset($button['url']) ? $this->evaluateExpression($button['url'],array('data'=>$data,'row'=>$row)) : '#';
    $options=isset($button['options']) ? $button['options'] : array();
    if(!isset($options['title']))
        $options['title']=$label;
    if(isset($button['imageUrl']) && is_string($button['imageUrl']))
        echo CHtml::link(CHtml::image($button['imageUrl'],$label),$url,$options);
    else
        echo CHtml::link($label,$url,$options);
}

Renders a link button.