DataColumn::init() - Code Metrics - Inspection of "Merge branch 'master' into fix-array-access" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — fix-array-access ( 050ccc...ecf3a7 )

by Alexander

created 2021-02-04 09:46 UTC

DataColumn::init() A

↳ Parent: DataColumn

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	0
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://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 <[email protected]>
 * @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 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 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 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 ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
                /* @var $modelClass Model */
                $modelClass = $provider->query->modelClass;

                $model = $modelClass::instance();
                $label = $model->getAttributeLabel($this->attribute);
            } elseif ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
                /* @var $modelClass Model */
                $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' => ''], $this->filterInputOptions);
                return Html::activeDropDownList($model, $this->filterAttribute, $this->filter, $options) . $error;
            } elseif ($this->format === 'boolean') {
                $options = array_merge(['prompt' => ''], $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);
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\grid;
9
10		use Closure;
11		use yii\base\Model;
12		use yii\data\ActiveDataProvider;
13		use yii\data\ArrayDataProvider;
14		use yii\db\ActiveQueryInterface;
15		use yii\helpers\ArrayHelper;
16		use yii\helpers\Html;
17		use yii\helpers\Inflector;
18
19		/**
20		* DataColumn is the default column type for the [[GridView]] widget.
21		*
22		* It is used to show data columns and allows [[enableSorting\|sorting]] and [[filter\|filtering]] them.
23		*
24		* A simple data column definition refers to an attribute in the data model of the
25		* GridView's data provider. The name of the attribute is specified by [[attribute]].
26		*
27		* By setting [[value]] and [[label]], the header and cell content can be customized.
28		*
29		* A data column differentiates between the [[getDataCellValue\|data cell value]] and the
30		* [[renderDataCellContent\|data cell content]]. The cell value is an un-formatted value that
31		* may be used for calculation, while the actual cell content is a [[format\|formatted]] version of that
32		* value which may contain HTML markup.
33		*
34		* For more details and usage information on DataColumn, see the [guide article on data widgets](guide:output-data-widgets).
35		*
36		* @author Qiang Xue <[email protected]>
37		* @since 2.0
38		*/
39		class DataColumn extends Column
40		{
41		/**
42		* @var string the attribute name associated with this column. When neither [[content]] nor [[value]]
43		* is specified, the value of the specified attribute will be retrieved from each data model and displayed.
44		*
45		* Also, if [[label]] is not specified, the label associated with the attribute will be displayed.
46		*/
47		public $attribute;
48		/**
49		* @var string label to be displayed in the [[header\|header cell]] and also to be used as the sorting
50		* link label when sorting is enabled for this column.
51		* If it is not set and the models provided by the GridViews data provider are instances
52		* of [[\yii\db\ActiveRecord]], the label will be determined using [[\yii\db\ActiveRecord::getAttributeLabel()]].
53		* Otherwise [[\yii\helpers\Inflector::camel2words()]] will be used to get a label.
54		*/
55		public $label;
56		/**
57		* @var bool whether the header label should be HTML-encoded.
58		* @see label
59		* @since 2.0.1
60		*/
61		public $encodeLabel = true;
62		/**
63		* @var string\|Closure an anonymous function or a string that is used to determine the value to display in the current column.
64		*
65		* If this is an anonymous function, it will be called for each row and the return value will be used as the value to
66		* display for every data model. The signature of this function should be: `function ($model, $key, $index, $column)`.
67		* Where `$model`, `$key`, and `$index` refer to the model, key and index of the row currently being rendered
68		* and `$column` is a reference to the [[DataColumn]] object.
69		*
70		* You may also set this property to a string representing the attribute name to be displayed in this column.
71		* This can be used when the attribute to be displayed is different from the [[attribute]] that is used for
72		* sorting and filtering.
73		*
74		* If this is not set, `$model[$attribute]` will be used to obtain the value, where `$attribute` is the value of [[attribute]].
75		*/
76		public $value;
77		/**
78		* @var string\|array\|Closure in which format should the value of each data model be displayed as (e.g. `"raw"`, `"text"`, `"html"`,
79		* `['date', 'php:Y-m-d']`). Supported formats are determined by the [[GridView::formatter\|formatter]] used by
80		* the [[GridView]]. Default format is "text" which will format the value as an HTML-encoded plain text when
81		* [[\yii\i18n\Formatter]] is used as the [[GridView::$formatter\|formatter]] of the GridView.
82		* @see \yii\i18n\Formatter::format()
83		*/
84		public $format = 'text';
85		/**
86		* @var bool whether to allow sorting by this column. If true and [[attribute]] is found in
87		* the sort definition of [[GridView::dataProvider]], then the header cell of this column
88		* will contain a link that may trigger the sorting when being clicked.
89		*/
90		public $enableSorting = true;
91		/**
92		* @var array the HTML attributes for the link tag in the header cell
93		* generated by [[\yii\data\Sort::link]] when sorting is enabled for this column.
94		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
95		*/
96		public $sortLinkOptions = [];
97		/**
98		* @var string\|array\|null\|false the HTML code representing a filter input (e.g. a text field, a dropdown list)
99		* that is used for this data column. This property is effective only when [[GridView::filterModel]] is set.
100		*
101		* - If this property is not set, a text field will be generated as the filter input with attributes defined
102		* with [[filterInputOptions]]. See [[\yii\helpers\BaseHtml::activeInput]] for details on how an active
103		* input tag is generated.
104		* - If this property is an array, a dropdown list will be generated that uses this property value as
105		* the list options.
106		* - If you don't want a filter for this data column, set this value to be false.
107		*/
108		public $filter;
109		/**
110		* @var array the HTML attributes for the filter input fields. This property is used in combination with
111		* the [[filter]] property. When [[filter]] is not set or is an array, this property will be used to
112		* render the HTML attributes for the generated filter input fields.
113		*
114		* Empty `id` in the default value ensures that id would not be obtained from the model attribute thus
115		* providing better performance.
116		*
117		* @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
118		*/
119		public $filterInputOptions = ['class' => 'form-control', 'id' => null];
120		/**
121		* @var string the attribute name of the [[GridView::filterModel]] associated with this column. If not set,
122		* will have the same value as [[attribute]].
123		* @since 2.0.41
124		*/
125		public $filterAttribute;
126
127
128		/**
129		* {@inheritdoc}
130		*/
131	8	public function init()
132		{
133	8	parent::init();
134	8	if($this->filterAttribute === null) {
135	7	$this->filterAttribute = $this->attribute;
136		}
137	8	}
138
139		/**
140		* {@inheritdoc}
141		*/
142		protected function renderHeaderCellContent()
143		{
144		if ($this->header !== null \|\| $this->label === null && $this->attribute === null) {
145		return parent::renderHeaderCellContent();
146		}
147
148		$label = $this->getHeaderCellLabel();
149		if ($this->encodeLabel) {
150		$label = Html::encode($label);
151		}
152
153		if ($this->attribute !== null && $this->enableSorting &&
154		($sort = $this->grid->dataProvider->getSort()) !== false && $sort->hasAttribute($this->attribute)) {
155		return $sort->link($this->attribute, array_merge($this->sortLinkOptions, ['label' => $label]));
156		}
157
158		return $label;
159		}
160
161		/**
162		* {@inheritdoc}
163		* @since 2.0.8
164		*/
165	2	protected function getHeaderCellLabel()
166		{
167	2	$provider = $this->grid->dataProvider;
168
169	2	if ($this->label === null) {
170	2	if ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
171		/* @var $modelClass Model */
172		$modelClass = $provider->query->modelClass;
		0 ignored issues – show Bug introduced 2019-02-03 21:14 UTC by Report Bug Copy Issue Report Accessing `modelClass` on the interface `yii\db\ActiveQueryInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? Loading history...
173		$model = $modelClass::instance();
174		$label = $model->getAttributeLabel($this->attribute);
175	2	} elseif ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
176		/* @var $modelClass Model */
177	1	$modelClass = $provider->modelClass;
178	1	$model = $modelClass::instance();
179	1	$label = $model->getAttributeLabel($this->attribute);
180	1	} elseif ($this->grid->filterModel !== null && $this->grid->filterModel instanceof Model) {
181	1	$label = $this->grid->filterModel->getAttributeLabel($this->filterAttribute);
182		} else {
183		$models = $provider->getModels();
184		if (($model = reset($models)) instanceof Model) {
185		/* @var $model Model */
186		$label = $model->getAttributeLabel($this->attribute);
187		} else {
188	2	$label = Inflector::camel2words($this->attribute);
189		}
190		}
191		} else {
192		$label = $this->label;
193		}
194
195	2	return $label;
196		}
197
198		/**
199		* {@inheritdoc}
200		*/
201	5	protected function renderFilterCellContent()
202		{
203	5	if (is_string($this->filter)) {
204	1	return $this->filter;
205		}
206
207	4	$model = $this->grid->filterModel;
208
209	4	if ($this->filter !== false && $model instanceof Model && $this->filterAttribute !== null && $model->isAttributeActive($this->filterAttribute)) {
210	4	if ($model->hasErrors($this->filterAttribute)) {
211		Html::addCssClass($this->filterOptions, 'has-error');
212		$error = ' ' . Html::error($model, $this->filterAttribute, $this->grid->filterErrorOptions);
213		} else {
214	4	$error = '';
215		}
216	4	if (is_array($this->filter)) {
217	1	$options = array_merge(['prompt' => ''], $this->filterInputOptions);
218	1	return Html::activeDropDownList($model, $this->filterAttribute, $this->filter, $options) . $error;
219	3	} elseif ($this->format === 'boolean') {
220	1	$options = array_merge(['prompt' => ''], $this->filterInputOptions);
221	1	return Html::activeDropDownList($model, $this->filterAttribute, [
222	1	1 => $this->grid->formatter->booleanFormat[1],
223	1	0 => $this->grid->formatter->booleanFormat[0],
224	1	], $options) . $error;
225		}
226	2	$options = array_merge(['maxlength' => true], $this->filterInputOptions);
227
228	2	return Html::activeTextInput($model, $this->filterAttribute, $options) . $error;
229		}
230
231		return parent::renderFilterCellContent();
232		}
233
234		/**
235		* Returns the data cell value.
236		* @param mixed $model the data model
237		* @param mixed $key the key associated with the data model
238		* @param int $index the zero-based index of the data model among the models array returned by [[GridView::dataProvider]].
239		* @return string the data cell value
240		*/
241		public function getDataCellValue($model, $key, $index)
242		{
243		if ($this->value !== null) {
244		if (is_string($this->value)) {
245		return ArrayHelper::getValue($model, $this->value);
246		}
247
248		return call_user_func($this->value, $model, $key, $index, $this);
249		} elseif ($this->attribute !== null) {
250		return ArrayHelper::getValue($model, $this->attribute);
251		}
252
253		return null;
254		}
255
256		/**
257		* {@inheritdoc}
258		*/
259		protected function renderDataCellContent($model, $key, $index)
260		{
261		if ($this->content === null) {
262		return $this->grid->formatter->format($this->getDataCellValue($model, $key, $index), $this->format);
263		}
264
265		return parent::renderDataCellContent($model, $key, $index);
266		}
267		}
268

yiisoft / yii2

Push — fix-array-access ( 050ccc...ecf3a7 )

DataColumn::init() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like