CButtonColumn

Package	zii.widgets.grid
Inheritance	class CButtonColumn » CGridColumn » CComponent
Since	1.1
Source Code	framework/zii/widgets/grid/CButtonColumn.php

Property Details

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.

Note that if success is true it does not mean that the delete was successful, it only means that the ajax call was successful.

Example:

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

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
)

In the PHP expression for the 'url' option and/or 'visible' option, the variable $row refers to the current row number (zero-based), and $data refers to the data model for the row. The PHP expression will be evaluated using evaluateExpression. A PHP expression can be any PHP code that has a value. To learn more about what an expression is, please refer to the php manual.

If the 'buttonID' is 'view', 'update' or 'delete' the options will be applied to the default buttons.

Note that in order to display non-default buttons, the template property needs to be configured so that the corresponding button IDs appear as tokens in the template.

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.

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

the HTML options for the delete button tag.

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 value provided by grid view object for the row.
• $this the column object.

Type of the $data depends on data provider which is passed to the grid view object. In case of CActiveDataProvider, $data will have object type and its values are accessed like $data->property. In case of CArrayDataProvider or CSqlDataProvider, it will have array type and its values must be accessed like $data['property'].

The PHP expression will be evaluated using evaluateExpression.

A PHP expression can be any PHP code that has a value. To learn more about what an expression is, please refer to the php manual.

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.

the HTML options for the footer cell tag.

the HTML options for the header cell tag.

the HTML options for the data cell tags.

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.

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.

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

the HTML options for the update button tag.

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 value provided by grid view object for the row.
• $this the column object.

Type of the $data depends on data provider which is passed to the grid view object. In case of CActiveDataProvider, $data will have object type and its values are accessed like $data->property. In case of CArrayDataProvider or CSqlDataProvider, it will have array type and its values must be accessed like $data['property'].

The PHP expression will be evaluated using evaluateExpression.

A PHP expression can be any PHP code that has a value. To learn more about what an expression is, please refer to the php manual.

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.

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

the HTML options for the view button tag.

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 value provided by grid view object for the row.
• $this the column object.

Type of the $data depends on data provider which is passed to the grid view object. In case of CActiveDataProvider, $data will have object type and its values are accessed like $data->property. In case of CArrayDataProvider or CSqlDataProvider, it will have array type and its values must be accessed like $data['property'].

The PHP expression will be evaluated using evaluateExpression.

A PHP expression can be any PHP code that has a value. To learn more about what an expression is, please refer to the php manual.

Method Details

public string getDataCellContent(integer $row)
$row	integer	the row number (zero-based)
{return}	string	the data cell content.

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

public void init()

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

protected void initDefaultButtons()

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

protected void registerClientScript()

Registers the client scripts for the button column.

protected void renderButton(string $id, array $button, integer $row, mixed $data)
$id	string	the ID of the button
$button	array	the button configuration which may contain 'label', 'url', 'imageUrl' and 'options' elements. See buttons for more details.
$row	integer	the row number (zero-based)
$data	mixed	the data object associated with the row

Renders a link button.