DataColumn::getHeaderCellLabel() - Code Metrics - Inspection of "Reorder pick attribute label" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14831)

unknown

created 2017-09-15 13:23 UTC

DataColumn::getHeaderCellLabel() C

↳ Parent: DataColumn

Complexity

Conditions	13
Paths	8

Size

Total Lines	41
Code Lines	22

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	34.125

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	41
ccs	11
cts	22
cp	0.5
rs	5.1234
cc	13
eloc	22
nc	8
nop	0
crap	34.125

How to fix Complexity

<?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\db\ActiveRecord;
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;
     * - 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.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $filterInputOptions = ['class' => 'form-control', 'id' => null];


    /**
     * @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) {
            return $this->label;
        }
        if ($provider instanceof ActiveDataProvider && $provider->query instanceof ActiveQueryInterface) {
            /* @var $modelClass Model */
            $modelClass = $provider->query->modelClass;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            if ($this->grid->filterModel !== null && $this->grid->filterModel instanceof $modelClass) {
                return $this->grid->filterModel->getAttributeLabel($this->attribute);
            }
            /* @var $model ActiveRecord */
            $model = $modelClass::instance();

            return $model->getAttributeLabel($this->attribute);
        }
        if ($provider instanceof ArrayDataProvider && $provider->modelClass !== null) {
            /* @var $modelClass Model */
            $modelClass = $provider->modelClass;
            if ($this->grid->filterModel !== null && $this->grid->filterModel instanceof $modelClass) {
                return $this->grid->filterModel->getAttributeLabel($this->attribute);
            }
            /* @var $model Model */
            $model = $modelClass::instance();

            return $model->getAttributeLabel($this->attribute);
        }
        if ($this->grid->filterModel !== null && $this->grid->filterModel instanceof Model) {
            return $this->grid->filterModel->getAttributeLabel($this->attribute);
        }

        $models = $provider->getModels();
        if (($model = reset($models)) instanceof Model) {
            /* @var $model Model */
            return $model->getAttributeLabel($this->attribute);
        }

        return Inflector::camel2words($this->attribute);
    }

    /**
     * @inheritdoc
     */
    protected function renderFilterCellContent()
    {
        if (is_string($this->filter)) {
            return $this->filter;
        }

        $model = $this->grid->filterModel;

        if ($this->filter !== false && $model instanceof Model && $this->attribute !== null && $model->isAttributeActive($this->attribute)) {
            if ($model->hasErrors($this->attribute)) {
                Html::addCssClass($this->filterOptions, 'has-error');
                $error = ' ' . Html::error($model, $this->attribute, $this->grid->filterErrorOptions);
            } else {
                $error = '';
            }
            if (is_array($this->filter)) {
                $options = array_merge(['prompt' => ''], $this->filterInputOptions);
                return Html::activeDropDownList($model, $this->attribute, $this->filter, $options) . $error;
            } elseif ($this->format === 'boolean') {
                $options = array_merge(['prompt' => ''], $this->filterInputOptions);
                return Html::activeDropDownList($model, $this->attribute, [
                    $this->grid->formatter->booleanFormat[0],
                    $this->grid->formatter->booleanFormat[1],
                ], $options) . $error;
            }

            return Html::activeTextInput($model, $this->attribute, $this->filterInputOptions) . $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);
    }
}


Pull Request — master (#14831)

DataColumn::getHeaderCellLabel() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Available Fixes

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

yiisoft / yii2

Pull Request — master (#14831)

DataColumn::getHeaderCellLabel() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like