|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* @link http://www.yiiframework.com/
|
|
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
|
|
* @license http://www.yiiframework.com/license/
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace yii\grid;
|
|
|
|
|
|
|
|
use Yii;
|
|
|
|
use Closure;
|
|
|
|
use yii\helpers\Html;
|
|
|
|
use yii\helpers\Url;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* ActionColumn is a column for the [[GridView]] widget that displays buttons for viewing and manipulating the items.
|
|
|
|
*
|
|
|
|
* To add an ActionColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows:
|
|
|
|
*
|
|
|
|
* ```php
|
|
|
|
* 'columns' => [
|
|
|
|
* // ...
|
|
|
|
* [
|
|
|
|
* 'class' => ActionColumn::className(),
|
|
|
|
* // you may configure additional properties here
|
|
|
|
* ],
|
|
|
|
* ]
|
|
|
|
* ```
|
|
|
|
*
|
|
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
|
|
* @since 2.0
|
|
|
|
*/
|
|
|
|
class ActionColumn extends Column
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @inheritdoc
|
|
|
|
*/
|
|
|
|
public $headerOptions = ['class' => 'action-column'];
|
|
|
|
/**
|
|
|
|
* @var string the ID of the controller that should handle the actions specified here.
|
|
|
|
* If not set, it will use the currently active controller. This property is mainly used by
|
|
|
|
* [[urlCreator]] to create URLs for different actions. The value of this property will be prefixed
|
|
|
|
* to each action name to form the route of the action.
|
|
|
|
*/
|
|
|
|
public $controller;
|
|
|
|
/**
|
|
|
|
* @var string the template used for composing each cell in the action column.
|
|
|
|
* Tokens enclosed within curly brackets are treated as controller action IDs (also called *button names*
|
|
|
|
* in the context of action column). They will be replaced by the corresponding button rendering callbacks
|
|
|
|
* specified in [[buttons]]. For example, the token `{view}` will be replaced by the result of
|
|
|
|
* the callback `buttons['view']`. If a callback cannot be found, the token will be replaced with an empty string.
|
|
|
|
*
|
|
|
|
* As an example, to only have the view, and update button you can add the ActionColumn to your GridView columns as follows:
|
|
|
|
*
|
|
|
|
* ```
|
|
|
|
* ['class' => 'yii\grid\ActionColumn', 'template' => '{view} {update}'],
|
|
|
|
* ```
|
|
|
|
*
|
|
|
|
* @see buttons
|
|
|
|
*/
|
|
|
|
public $template = '{view} {update} {delete}';
|
|
|
|
/**
|
|
|
|
* @var array button rendering callbacks. The array keys are the button names (without curly brackets),
|
|
|
|
* and the values are the corresponding button rendering callbacks. The callbacks should use the following
|
|
|
|
* signature:
|
|
|
|
*
|
|
|
|
* ```php
|
|
|
|
* function ($url, $model, $key) {
|
|
|
|
* // return the button HTML code
|
|
|
|
* }
|
|
|
|
* ```
|
|
|
|
*
|
|
|
|
* where `$url` is the URL that the column creates for the button, `$model` is the model object
|
|
|
|
* being rendered for the current row, and `$key` is the key of the model in the data provider array.
|
|
|
|
*
|
|
|
|
* You can add further conditions to the button, for example only display it, when the model is
|
|
|
|
* editable (here assuming you have a status field that indicates that):
|
|
|
|
*
|
|
|
|
* ```php
|
|
|
|
* [
|
|
|
|
* 'update' => function ($url, $model, $key) {
|
|
|
|
* return $model->status === 'editable' ? Html::a('Update', $url) : '';
|
|
|
|
* },
|
|
|
|
* ],
|
|
|
|
* ```
|
|
|
|
*/
|
|
|
|
public $buttons = [];
|
|
|
|
/**
|
|
|
|
* @var callable a callback that creates a button URL using the specified model information.
|
|
|
|
* The signature of the callback should be the same as that of [[createUrl()]].
|
|
|
|
* If this property is not set, button URLs will be created using [[createUrl()]].
|
|
|
|
*/
|
|
|
|
public $urlCreator;
|
|
|
|
/**
|
|
|
|
* @var array html options to be applied to the [[initDefaultButtons()|default buttons]].
|
|
|
|
* @since 2.0.4
|
|
|
|
*/
|
|
|
|
public $buttonOptions = [];
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @inheritdoc
|
|
|
|
*/
|
|
|
|
public function init()
|
|
|
|
{
|
|
|
|
parent::init();
|
|
|
|
$this->initDefaultButtons();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Initializes the default button rendering callbacks.
|
|
|
|
*/
|
|
|
|
protected function initDefaultButtons()
|
|
|
|
{
|
|
|
|
if (!isset($this->buttons['view'])) {
|
|
|
|
$this->buttons['view'] = function ($url, $model, $key) {
|
|
|
|
$options = array_merge([
|
|
|
|
'title' => Yii::t('yii', 'View'),
|
|
|
|
'aria-label' => Yii::t('yii', 'View'),
|
|
|
|
'data-pjax' => '0',
|
|
|
|
], $this->buttonOptions);
|
|
|
|
return Html::a('<span class="glyphicon glyphicon-eye-open"></span>', $url, $options);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
if (!isset($this->buttons['update'])) {
|
|
|
|
$this->buttons['update'] = function ($url, $model, $key) {
|
|
|
|
$options = array_merge([
|
|
|
|
'title' => Yii::t('yii', 'Update'),
|
|
|
|
'aria-label' => Yii::t('yii', 'Update'),
|
|
|
|
'data-pjax' => '0',
|
|
|
|
], $this->buttonOptions);
|
|
|
|
return Html::a('<span class="glyphicon glyphicon-pencil"></span>', $url, $options);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
if (!isset($this->buttons['delete'])) {
|
|
|
|
$this->buttons['delete'] = function ($url, $model, $key) {
|
|
|
|
$options = array_merge([
|
|
|
|
'title' => Yii::t('yii', 'Delete'),
|
|
|
|
'aria-label' => Yii::t('yii', 'Delete'),
|
|
|
|
'data-confirm' => Yii::t('yii', 'Are you sure you want to delete this item?'),
|
|
|
|
'data-method' => 'post',
|
|
|
|
'data-pjax' => '0',
|
|
|
|
], $this->buttonOptions);
|
|
|
|
return Html::a('<span class="glyphicon glyphicon-trash"></span>', $url, $options);
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a URL for the given action and model.
|
|
|
|
* This method is called for each button and each row.
|
|
|
|
* @param string $action the button name (or action ID)
|
|
|
|
* @param \yii\db\ActiveRecord $model the data model
|
|
|
|
* @param mixed $key the key associated with the data model
|
|
|
|
* @param integer $index the current row index
|
|
|
|
* @return string the created URL
|
|
|
|
*/
|
|
|
|
public function createUrl($action, $model, $key, $index)
|
|
|
|
{
|
|
|
|
if (is_callable($this->urlCreator)) {
|
|
|
|
return call_user_func($this->urlCreator, $action, $model, $key, $index);
|
|
|
|
} else {
|
|
|
|
$params = is_array($key) ? $key : ['id' => (string) $key];
|
|
|
|
$params[0] = $this->controller ? $this->controller . '/' . $action : $action;
|
|
|
|
|
|
|
|
return Url::toRoute($params);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @inheritdoc
|
|
|
|
*/
|
|
|
|
protected function renderDataCellContent($model, $key, $index)
|
|
|
|
{
|
|
|
|
return preg_replace_callback('/\\{([\w\-\/]+)\\}/', function ($matches) use ($model, $key, $index) {
|
|
|
|
$name = $matches[1];
|
|
|
|
if (isset($this->buttons[$name])) {
|
|
|
|
$url = $this->createUrl($name, $model, $key, $index);
|
|
|
|
|
|
|
|
return call_user_func($this->buttons[$name], $url, $model, $key);
|
|
|
|
} else {
|
|
|
|
return '';
|
|
|
|
}
|
|
|
|
}, $this->template);
|
|
|
|
}
|
|
|
|
}
|