ActionColumn.php 4.69 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12
<?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;
13
use yii\helpers\Url;
Qiang Xue committed
14 15

/**
16 17
 * ActionColumn is a column for the [[GridView]] widget that displays buttons for viewing and manipulating the items.
 *
18 19 20 21 22 23 24 25 26 27 28 29
 * To add an ActionColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows:
 *
 * ```php
 * 'columns' => [
 *     // ...
 *     [
 *         'class' => 'yii\grid\ActionColumn',
 *         // you may configure additional properties here
 *     ],
 * ]
 * ```
 *
Qiang Xue committed
30 31 32 33 34
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class ActionColumn extends Column
{
35 36 37 38 39 40 41
	/**
	 * @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;
42 43 44 45 46 47 48 49
	/**
	 * @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.
	 * @see buttons
	 */
Qiang Xue committed
50
	public $template = '{view} {update} {delete}';
51 52 53 54 55 56 57 58 59 60 61 62 63 64
	/**
	 * @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) {
	 *     // return the button HTML code
	 * }
	 * ```
	 *
	 * where `$url` is the URL that the column creates for the button, and `$model` is the model object
	 * being rendered for the current row.
	 */
Alexander Makarov committed
65
	public $buttons = [];
66
	/**
67
	 * @var callable a callback that creates a button URL using the specified model information.
68 69 70
	 * 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()]].
	 */
Qiang Xue committed
71 72
	public $urlCreator;

73 74 75 76

	/**
	 * @inheritdoc
	 */
Qiang Xue committed
77 78 79 80 81 82
	public function init()
	{
		parent::init();
		$this->initDefaultButtons();
	}

83 84 85
	/**
	 * Initializes the default button rendering callbacks
	 */
Qiang Xue committed
86 87 88
	protected function initDefaultButtons()
	{
		if (!isset($this->buttons['view'])) {
89
			$this->buttons['view'] = function ($url, $model) {
Alexander Makarov committed
90
				return Html::a('<span class="glyphicon glyphicon-eye-open"></span>', $url, [
Qiang Xue committed
91
					'title' => Yii::t('yii', 'View'),
92
					'data-pjax' => '0',
Alexander Makarov committed
93
				]);
Qiang Xue committed
94 95 96
			};
		}
		if (!isset($this->buttons['update'])) {
97
			$this->buttons['update'] = function ($url, $model) {
Alexander Makarov committed
98
				return Html::a('<span class="glyphicon glyphicon-pencil"></span>', $url, [
Qiang Xue committed
99
					'title' => Yii::t('yii', 'Update'),
100
					'data-pjax' => '0',
Alexander Makarov committed
101
				]);
Qiang Xue committed
102 103 104
			};
		}
		if (!isset($this->buttons['delete'])) {
105
			$this->buttons['delete'] = function ($url, $model) {
Alexander Makarov committed
106
				return Html::a('<span class="glyphicon glyphicon-trash"></span>', $url, [
Qiang Xue committed
107 108 109
					'title' => Yii::t('yii', 'Delete'),
					'data-confirm' => Yii::t('yii', 'Are you sure to delete this item?'),
					'data-method' => 'post',
110
					'data-pjax' => '0',
Alexander Makarov committed
111
				]);
Qiang Xue committed
112 113 114 115 116
			};
		}
	}

	/**
117 118 119 120
	 * 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
121
	 * @param mixed $key the key associated with the data model
122 123
	 * @param integer $index the current row index
	 * @return string the created URL
Qiang Xue committed
124
	 */
125
	public function createUrl($action, $model, $key, $index)
Qiang Xue committed
126 127
	{
		if ($this->urlCreator instanceof Closure) {
128
			return call_user_func($this->urlCreator, $action, $model, $key, $index);
Qiang Xue committed
129
		} else {
130
			$params = is_array($key) ? $key : ['id' => (string)$key];
131
			$params[0] = $this->controller ? $this->controller . '/' . $action : $action;
132
			return Url::toRoute($params);
Qiang Xue committed
133 134 135 136
		}
	}

	/**
137
	 * @inheritdoc
Qiang Xue committed
138
	 */
139
	protected function renderDataCellContent($model, $key, $index)
Qiang Xue committed
140
	{
141
		return preg_replace_callback('/\\{([\w\-\/]+)\\}/', function ($matches) use ($model, $key, $index) {
Qiang Xue committed
142
			$name = $matches[1];
143
			if (isset($this->buttons[$name])) {
144 145
				$url = $this->createUrl($name, $model, $key, $index);
				return call_user_func($this->buttons[$name], $url, $model);
Qiang Xue committed
146 147 148 149 150 151
			} else {
				return '';
			}
		}, $this->template);
	}
}