mirror of
https://github.com/yiisoft/yii2.git
synced 2025-10-31 02:28:35 +08:00
272 lines
11 KiB
PHP
272 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* @link https://www.yiiframework.com/
|
|
* @copyright Copyright (c) 2008 Yii Software LLC
|
|
* @license https://www.yiiframework.com/license/
|
|
*/
|
|
|
|
namespace yii\grid;
|
|
|
|
use Closure;
|
|
use yii\base\Model;
|
|
use yii\data\ActiveDataProvider;
|
|
use yii\data\ArrayDataProvider;
|
|
use yii\db\ActiveQueryInterface;
|
|
use yii\helpers\ArrayHelper;
|
|
use yii\helpers\Html;
|
|
use yii\helpers\Inflector;
|
|
|
|
/**
|
|
* DataColumn is the default column type for the [[GridView]] widget.
|
|
*
|
|
* It is used to show data columns and allows [[enableSorting|sorting]] and [[filter|filtering]] them.
|
|
*
|
|
* A simple data column definition refers to an attribute in the data model of the
|
|
* GridView's data provider. The name of the attribute is specified by [[attribute]].
|
|
*
|
|
* By setting [[value]] and [[label]], the header and cell content can be customized.
|
|
*
|
|
* A data column differentiates between the [[getDataCellValue|data cell value]] and the
|
|
* [[renderDataCellContent|data cell content]]. The cell value is an un-formatted value that
|
|
* may be used for calculation, while the actual cell content is a [[format|formatted]] version of that
|
|
* value which may contain HTML markup.
|
|
*
|
|
* For more details and usage information on DataColumn, see the [guide article on data widgets](guide:output-data-widgets).
|
|
*
|
|
* @author Qiang Xue <qiang.xue@gmail.com>
|
|
* @since 2.0
|
|
*/
|
|
class DataColumn extends Column
|
|
{
|
|
/**
|
|
* @var string the attribute name associated with this column. When neither [[content]] nor [[value]]
|
|
* is specified, the value of the specified attribute will be retrieved from each data model and displayed.
|
|
*
|
|
* Also, if [[label]] is not specified, the label associated with the attribute will be displayed.
|
|
*/
|
|
public $attribute;
|
|
/**
|
|
* @var string|null label to be displayed in the [[header|header cell]] and also to be used as the sorting
|
|
* link label when sorting is enabled for this column.
|
|
* If it is not set and the models provided by the GridViews data provider are instances
|
|
* of [[\yii\db\ActiveRecord]], the label will be determined using [[\yii\db\ActiveRecord::getAttributeLabel()]].
|
|
* Otherwise [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
|
|
*/
|
|
public $label;
|
|
/**
|
|
* @var bool whether the header label should be HTML-encoded.
|
|
* @see label
|
|
* @since 2.0.1
|
|
*/
|
|
public $encodeLabel = true;
|
|
/**
|
|
* @var string|Closure|null an anonymous function or a string that is used to determine the value to display in the current column.
|
|
*
|
|
* If this is an anonymous function, it will be called for each row and the return value will be used as the value to
|
|
* display for every data model. The signature of this function should be: `function ($model, $key, $index, $column)`.
|
|
* Where `$model`, `$key`, and `$index` refer to the model, key and index of the row currently being rendered
|
|
* and `$column` is a reference to the [[DataColumn]] object.
|
|
*
|
|
* You may also set this property to a string representing the attribute name to be displayed in this column.
|
|
* This can be used when the attribute to be displayed is different from the [[attribute]] that is used for
|
|
* sorting and filtering.
|
|
*
|
|
* If this is not set, `$model[$attribute]` will be used to obtain the value, where `$attribute` is the value of [[attribute]].
|
|
*/
|
|
public $value;
|
|
/**
|
|
* @var string|array|Closure in which format should the value of each data model be displayed as (e.g. `"raw"`, `"text"`, `"html"`,
|
|
* `['date', 'php:Y-m-d']`). Supported formats are determined by the [[GridView::formatter|formatter]] used by
|
|
* the [[GridView]]. Default format is "text" which will format the value as an HTML-encoded plain text when
|
|
* [[\yii\i18n\Formatter]] is used as the [[GridView::$formatter|formatter]] of the GridView.
|
|
* @see \yii\i18n\Formatter::format()
|
|
*/
|
|
public $format = 'text';
|
|
/**
|
|
* @var bool whether to allow sorting by this column. If true and [[attribute]] is found in
|
|
* the sort definition of [[GridView::dataProvider]], then the header cell of this column
|
|
* will contain a link that may trigger the sorting when being clicked.
|
|
*/
|
|
public $enableSorting = true;
|
|
/**
|
|
* @var array the HTML attributes for the link tag in the header cell
|
|
* generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
|
|
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
|
|
*/
|
|
public $sortLinkOptions = [];
|
|
/**
|
|
* @var string|array|null|false the HTML code representing a filter input (e.g. a text field, a dropdown list)
|
|
* that is used for this data column. This property is effective only when [[GridView::filterModel]] is set.
|
|
*
|
|
* - If this property is not set, a text field will be generated as the filter input with attributes defined
|
|
* with [[filterInputOptions]]. See [[\yii\helpers\BaseHtml::activeInput]] for details on how an active
|
|
* input tag is generated.
|
|
* - If this property is an array, a dropdown list will be generated that uses this property value as
|
|
* the list options.
|
|
* - If you don't want a filter for this data column, set this value to be false.
|
|
*/
|
|
public $filter;
|
|
/**
|
|
* @var array the HTML attributes for the filter input fields. This property is used in combination with
|
|
* the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
|
|
* render the HTML attributes for the generated filter input fields.
|
|
*
|
|
* Empty `id` in the default value ensures that id would not be obtained from the model attribute thus
|
|
* providing better performance.
|
|
*
|
|
* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
|
|
*/
|
|
public $filterInputOptions = ['class' => 'form-control', 'id' => null];
|
|
/**
|
|
* @var string|null the attribute name of the [[GridView::filterModel]] associated with this column. If not set,
|
|
* will have the same value as [[attribute]].
|
|
* @since 2.0.41
|
|
*/
|
|
public $filterAttribute;
|
|
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function init()
|
|
{
|
|
parent::init();
|
|
if ($this->filterAttribute === null) {
|
|
$this->filterAttribute = $this->attribute;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function renderHeaderCellContent()
|
|
{
|
|
if ($this->header !== null || $this->label === null && $this->attribute === null) {
|
|
return parent::renderHeaderCellContent();
|
|
}
|
|
|
|
$label = $this->getHeaderCellLabel();
|
|
if ($this->encodeLabel) {
|
|
$label = Html::encode($label);
|
|
}
|
|
|
|
if (
|
|
$this->attribute !== null && $this->enableSorting &&
|
|
($sort = $this->grid->dataProvider->getSort()) !== false && $sort->hasAttribute($this->attribute)
|
|
) {
|
|
return $sort->link($this->attribute, array_merge($this->sortLinkOptions, ['label' => $label]));
|
|
}
|
|
|
|
return $label;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
* @since 2.0.8
|
|
*/
|
|
protected function getHeaderCellLabel()
|
|
{
|
|
$provider = $this->grid->dataProvider;
|
|
|
|
if ($this->label === null) {
|
|
if ($this->attribute === null) {
|
|
$label = '';
|
|
} elseif ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
|
|
/** @var Model $modelClass */
|
|
$modelClass = $provider->query->modelClass;
|
|
$model = $modelClass::instance();
|
|
$label = $model->getAttributeLabel($this->attribute);
|
|
} elseif ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
|
|
/** @var Model $modelClass */
|
|
$modelClass = $provider->modelClass;
|
|
$model = $modelClass::instance();
|
|
$label = $model->getAttributeLabel($this->attribute);
|
|
} elseif ($this->grid->filterModel !== null && $this->grid->filterModel instanceof Model) {
|
|
$label = $this->grid->filterModel->getAttributeLabel($this->filterAttribute);
|
|
} else {
|
|
$models = $provider->getModels();
|
|
if (($model = reset($models)) instanceof Model) {
|
|
/** @var Model $model */
|
|
$label = $model->getAttributeLabel($this->attribute);
|
|
} else {
|
|
$label = Inflector::camel2words($this->attribute);
|
|
}
|
|
}
|
|
} else {
|
|
$label = $this->label;
|
|
}
|
|
|
|
return $label;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function renderFilterCellContent()
|
|
{
|
|
if (is_string($this->filter)) {
|
|
return $this->filter;
|
|
}
|
|
|
|
$model = $this->grid->filterModel;
|
|
|
|
if ($this->filter !== false && $model instanceof Model && $this->filterAttribute !== null && $model->isAttributeActive($this->filterAttribute)) {
|
|
if ($model->hasErrors($this->filterAttribute)) {
|
|
Html::addCssClass($this->filterOptions, 'has-error');
|
|
$error = ' ' . Html::error($model, $this->filterAttribute, $this->grid->filterErrorOptions);
|
|
} else {
|
|
$error = '';
|
|
}
|
|
if (is_array($this->filter)) {
|
|
$options = array_merge(['prompt' => '', 'strict' => true], $this->filterInputOptions);
|
|
return Html::activeDropDownList($model, $this->filterAttribute, $this->filter, $options) . $error;
|
|
} elseif ($this->format === 'boolean') {
|
|
$options = array_merge(['prompt' => '', 'strict' => true], $this->filterInputOptions);
|
|
return Html::activeDropDownList($model, $this->filterAttribute, [
|
|
1 => $this->grid->formatter->booleanFormat[1],
|
|
0 => $this->grid->formatter->booleanFormat[0],
|
|
], $options) . $error;
|
|
}
|
|
$options = array_merge(['maxlength' => true], $this->filterInputOptions);
|
|
|
|
return Html::activeTextInput($model, $this->filterAttribute, $options) . $error;
|
|
}
|
|
|
|
return parent::renderFilterCellContent();
|
|
}
|
|
|
|
/**
|
|
* Returns the data cell value.
|
|
* @param mixed $model the data model
|
|
* @param mixed $key the key associated with the data model
|
|
* @param int $index the zero-based index of the data model among the models array returned by [[GridView::dataProvider]].
|
|
* @return string the data cell value
|
|
*/
|
|
public function getDataCellValue($model, $key, $index)
|
|
{
|
|
if ($this->value !== null) {
|
|
if (is_string($this->value)) {
|
|
return ArrayHelper::getValue($model, $this->value);
|
|
}
|
|
|
|
return call_user_func($this->value, $model, $key, $index, $this);
|
|
} elseif ($this->attribute !== null) {
|
|
return ArrayHelper::getValue($model, $this->attribute);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
protected function renderDataCellContent($model, $key, $index)
|
|
{
|
|
if ($this->content === null) {
|
|
return $this->grid->formatter->format($this->getDataCellValue($model, $key, $index), $this->format);
|
|
}
|
|
|
|
return parent::renderDataCellContent($model, $key, $index);
|
|
}
|
|
}
|