BillGridView::objectTag() - Code Metrics - Inspection of "Merge pull request #22 from pkolomiy/request" - hiqdev/hipanel-module-finance - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b864d9...3fa98b )

by Dmitry

created 2018-08-15 12:04 UTC

BillGridView::objectTag() A

↳ Parent: BillGridView

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php
/**
 * Finance module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-finance
 * @package   hipanel-module-finance
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\finance\grid;

use hipanel\grid\CurrencyColumn;
use hipanel\grid\MainColumn;
use hipanel\helpers\StringHelper;
use hipanel\helpers\Url;
use hipanel\modules\finance\logic\bill\QuantityFormatterFactoryInterface;
use hipanel\modules\finance\menus\BillActionsMenu;
use hipanel\modules\finance\models\Bill;
use hipanel\modules\finance\widgets\BillTypeFilter;
use hipanel\modules\finance\widgets\ColoredBalance;
use hipanel\widgets\ArraySpoiler;
use hiqdev\yii2\menus\grid\MenuColumn;
use Yii;
use yii\helpers\Html;

/**
 * Class BillGridView
 *
 * @author Dmytro Naumenko <[email protected]>
 */
class BillGridView extends \hipanel\grid\BoxedGridView
{
    /**
     * @var QuantityFormatterFactoryInterface
     */
    private $quantityFactory;

    public function __construct(QuantityFormatterFactoryInterface $quantityFactory, array $config = [])
    {
        parent::__construct($config);

        $this->quantityFactory = $quantityFactory;
    }

    public $currencies = [];

    public function columns()
    {
        return array_merge(parent::columns(), [
            'bill' => [
                'class' => MainColumn::class,
                'attribute' => 'bill',
                'filterAttribute' => 'bill_like',
            ],
            'time' => [
                'format' => 'html',
                'filter' => false,
                'contentOptions' => ['class' => 'text-nowrap'],
                'value' => function ($model) {

                    list($date, $time) = explode(' ', $model->time, 2);

                    if (\in_array($model->gtype, [
                        'discount', 'domain', 'monthly', 'overuse', 'premium_package',
                        'feature', 'intercept', 'periodic',
                    ], true)) {
                        return Yii::$app->formatter->asDate($date, 'LLLL y');
                    }

                    return $time === '00:00:00' ? Yii::$app->formatter->asDate($date) : Yii::$app->formatter->asDateTime($model->time);
                },
            ],
            'sum' => [
                'class' => CurrencyColumn::class,
                'attribute' => 'sum',
                'colors' => ['danger' => 'warning'],
                'headerOptions' => ['class' => 'text-right'],
                'contentOptions' => function ($model) {
                    return ['class' => 'text-right' . ($model->sum > 0 ? ' text-bold' : '')];
                },
            ],
            'sum_editable' => [
                'class' => CurrencyColumn::class,
                'format' => 'raw',
                'attribute' => 'sum',
                'colors' => ['danger' => 'warning'],
                'headerOptions' => ['class' => 'text-right'],
                'urlCallback' => function ($model, $key) {

                    return Yii::$app->user->can('bill.read')
                        ? Url::to(['@bill/view', 'id' => $model->id])
                        : null;
                },
                'contentOptions' => function ($model) {
                    return ['class' => 'text-right' . ($model->sum > 0 ? ' text-bold' : '')];
                },
            ],
            'quantity' => [
                'format' => 'raw',
                'headerOptions' => ['class' => 'text-right'],
                'contentOptions' => ['class' => 'text-right text-bold'],
                'value' => function (Bill $bill) {
                    return $this->formatQuantity($bill);
                }
            ],
            'balance' => [
                'attribute' => 'balance',
                'format' => 'raw',
                'headerOptions' => ['class' => 'text-right'],
                'contentOptions' => function ($model, $key, $index) {
                    return ['class' => 'text-right' . ($index ? '' : ' text-bold')];
                },
                'value' => function ($model) {
                    return ColoredBalance::widget(compact('model'));
                },
                'filterAttribute' => 'currency_in',
                'filterOptions' => ['class' => 'narrow-filter'],
                'filter' => function ($column, $filterModel) {
                    $currencies = array_combine(array_keys($this->currencies), array_map(function ($k) {
                        return StringHelper::getCurrencySymbol($k);
                    }, array_keys($this->currencies)));

                    return Html::activeDropDownList($filterModel, 'currency_in', $currencies, ['class' => 'form-control', 'prompt' => '--']);
                }
            ],
            'gtype' => [
                'attribute' => 'gtype',
            ],
            'type_label' => [
                'filter' => function ($column, $filterModel) {
                    return BillTypeFilter::widget([
                        'options' => ['class' => 'form-control text-right'],
                        'attribute' => 'ftype',
                        'model' => $filterModel,
                    ]);
                },
                'format' => 'raw',
                'headerOptions' => ['class' => 'text-right'],
                'contentOptions' => function ($model) {

                    return ['class' => 'text-right'];
                },
                'value' => function ($model) {

                    static $colors = [
                        'correction' => 'normal',
                        'exchange' => 'warning',
                        'deposit' => 'success',
                    ];
                    $color = $colors[$model->gtype] ?: 'muted';

                    return Html::tag('b', Yii::t('hipanel:finance', $model->type_label), ['class' => "text-$color"]);
                },
            ],
            'description' => [
                'attribute' => 'descr',
                'format' => 'raw',
                'value' => function ($model) {
                    $descr = $model->descr ?: $model->label;
                    $text = mb_strlen($descr) > 70 ? ArraySpoiler::widget(['data' => $descr]) : $descr;
                    $tariff = $model->tariff ? Html::tag('span',
                        Yii::t('hipanel', 'Tariff') . ': ' . Html::a($model->tariff,
                            ['@tariff/view', 'id' => $model->tariff_id]), ['class' => 'pull-right']) : '';
                    $amount = $this->formatQuantity($model);
                    $object = $this->objectTag($model);

                    return $tariff . $amount . ' ' . implode('<br>', array_filter([$object, $text]));
                },
            ],
            'tariff_link' => [
                'attribute' => 'tariff',
                'format' => 'html',
                'value' => function ($model) {
                    return $this->tariffLink($model);
                },
            ],
            'object' => [
                'attribute' => 'object',
                'format' => 'html',
                'value' => function ($model) {
                    return $this->objectTag($model);
                },
            ],
            'actions' => [
                'class' => MenuColumn::class,
                'menuClass' => BillActionsMenu::class,
            ],
        ]);
    }

    public function tariffLink($model): string
    {
        return Html::a($model->tariff, ['@tariff/view', 'id' => $model->tariff_id]);
    }

    public function objectTag($model): string
    {
        return $model->object ? implode(':&nbsp;', [$model->class_label, $this->objectLink($model)]) : '';
    }

    /**
     * Creates link to object details page.
     *
     * @param Bill $model
     * @return string
     */
    public function objectLink(Bill $model): string
    {
        return $model->class === 'device'
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            ? Html::a($model->object, ['@server/view', 'id' => $model->object_id])
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            : Html::tag('b', $model->object);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    private function formatQuantity(Bill $bill): string
    {
        $billQty = $this->quantityFactory->forBill($bill);

        if ($billQty !== null) {
            return Html::tag('nobr', Html::tag('b', $billQty->format()));
        }

        return '';
    }
}


1		<?php
2		/**
3		* Finance module for HiPanel
4		*
5		* @link https://github.com/hiqdev/hipanel-module-finance
6		* @package hipanel-module-finance
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hipanel\modules\finance\grid;
12
13		use hipanel\grid\CurrencyColumn;
14		use hipanel\grid\MainColumn;
15		use hipanel\helpers\StringHelper;
16		use hipanel\helpers\Url;
17		use hipanel\modules\finance\logic\bill\QuantityFormatterFactoryInterface;
18		use hipanel\modules\finance\menus\BillActionsMenu;
19		use hipanel\modules\finance\models\Bill;
20		use hipanel\modules\finance\widgets\BillTypeFilter;
21		use hipanel\modules\finance\widgets\ColoredBalance;
22		use hipanel\widgets\ArraySpoiler;
23		use hiqdev\yii2\menus\grid\MenuColumn;
24		use Yii;
25		use yii\helpers\Html;
26
27		/**
28		* Class BillGridView
29		*
30		* @author Dmytro Naumenko <[email protected]>
31		*/
32		class BillGridView extends \hipanel\grid\BoxedGridView
33		{
34		/**
35		* @var QuantityFormatterFactoryInterface
36		*/
37		private $quantityFactory;
38
39		public function __construct(QuantityFormatterFactoryInterface $quantityFactory, array $config = [])
40		{
41		parent::__construct($config);
42
43		$this->quantityFactory = $quantityFactory;
44		}
45
46		public $currencies = [];
47
48		public function columns()
49		{
50		return array_merge(parent::columns(), [
51		'bill' => [
52		'class' => MainColumn::class,
53		'attribute' => 'bill',
54		'filterAttribute' => 'bill_like',
55		],
56		'time' => [
57		'format' => 'html',
58		'filter' => false,
59		'contentOptions' => ['class' => 'text-nowrap'],
60	View Code Duplication	'value' => function ($model) {
		0 ignored issues – show Duplication introduced 2017-06-12 16:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
61		list($date, $time) = explode(' ', $model->time, 2);
62
63		if (\in_array($model->gtype, [
64		'discount', 'domain', 'monthly', 'overuse', 'premium_package',
65		'feature', 'intercept', 'periodic',
66		], true)) {
67		return Yii::$app->formatter->asDate($date, 'LLLL y');
68		}
69
70		return $time === '00:00:00' ? Yii::$app->formatter->asDate($date) : Yii::$app->formatter->asDateTime($model->time);
71		},
72		],
73		'sum' => [
74		'class' => CurrencyColumn::class,
75		'attribute' => 'sum',
76		'colors' => ['danger' => 'warning'],
77		'headerOptions' => ['class' => 'text-right'],
78		'contentOptions' => function ($model) {
79		return ['class' => 'text-right' . ($model->sum > 0 ? ' text-bold' : '')];
80		},
81		],
82		'sum_editable' => [
83		'class' => CurrencyColumn::class,
84		'format' => 'raw',
85		'attribute' => 'sum',
86		'colors' => ['danger' => 'warning'],
87		'headerOptions' => ['class' => 'text-right'],
88		'urlCallback' => function ($model, $key) {
		0 ignored issues – show Unused Code introduced 2016-11-04 17:43 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
89		return Yii::$app->user->can('bill.read')
90		? Url::to(['@bill/view', 'id' => $model->id])
91		: null;
92		},
93		'contentOptions' => function ($model) {
94		return ['class' => 'text-right' . ($model->sum > 0 ? ' text-bold' : '')];
95		},
96		],
97		'quantity' => [
98		'format' => 'raw',
99		'headerOptions' => ['class' => 'text-right'],
100		'contentOptions' => ['class' => 'text-right text-bold'],
101		'value' => function (Bill $bill) {
102		return $this->formatQuantity($bill);
103		}
104		],
105		'balance' => [
106		'attribute' => 'balance',
107		'format' => 'raw',
108		'headerOptions' => ['class' => 'text-right'],
109		'contentOptions' => function ($model, $key, $index) {
110		return ['class' => 'text-right' . ($index ? '' : ' text-bold')];
111		},
112		'value' => function ($model) {
113		return ColoredBalance::widget(compact('model'));
114		},
115		'filterAttribute' => 'currency_in',
116		'filterOptions' => ['class' => 'narrow-filter'],
117		'filter' => function ($column, $filterModel) {
118		$currencies = array_combine(array_keys($this->currencies), array_map(function ($k) {
119		return StringHelper::getCurrencySymbol($k);
120		}, array_keys($this->currencies)));
121
122		return Html::activeDropDownList($filterModel, 'currency_in', $currencies, ['class' => 'form-control', 'prompt' => '--']);
123		}
124		],
125		'gtype' => [
126		'attribute' => 'gtype',
127		],
128		'type_label' => [
129		'filter' => function ($column, $filterModel) {
130		return BillTypeFilter::widget([
131		'options' => ['class' => 'form-control text-right'],
132		'attribute' => 'ftype',
133		'model' => $filterModel,
134		]);
135		},
136		'format' => 'raw',
137		'headerOptions' => ['class' => 'text-right'],
138		'contentOptions' => function ($model) {
		0 ignored issues – show Unused Code introduced 2016-06-24 07:57 UTC by Report Bug Copy Issue Report The parameter `$model` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
139		return ['class' => 'text-right'];
140		},
141	View Code Duplication	'value' => function ($model) {
		0 ignored issues – show Duplication introduced 2017-06-12 16:06 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142		static $colors = [
143		'correction' => 'normal',
144		'exchange' => 'warning',
145		'deposit' => 'success',
146		];
147		$color = $colors[$model->gtype] ?: 'muted';
148
149		return Html::tag('b', Yii::t('hipanel:finance', $model->type_label), ['class' => "text-$color"]);
150		},
151		],
152		'description' => [
153		'attribute' => 'descr',
154		'format' => 'raw',
155		'value' => function ($model) {
156		$descr = $model->descr ?: $model->label;
157		$text = mb_strlen($descr) > 70 ? ArraySpoiler::widget(['data' => $descr]) : $descr;
158		$tariff = $model->tariff ? Html::tag('span',
159		Yii::t('hipanel', 'Tariff') . ': ' . Html::a($model->tariff,
160		['@tariff/view', 'id' => $model->tariff_id]), ['class' => 'pull-right']) : '';
161		$amount = $this->formatQuantity($model);
162		$object = $this->objectTag($model);
163
164		return $tariff . $amount . ' ' . implode('<br>', array_filter([$object, $text]));
165		},
166		],
167		'tariff_link' => [
168		'attribute' => 'tariff',
169		'format' => 'html',
170		'value' => function ($model) {
171		return $this->tariffLink($model);
172		},
173		],
174		'object' => [
175		'attribute' => 'object',
176		'format' => 'html',
177		'value' => function ($model) {
178		return $this->objectTag($model);
179		},
180		],
181		'actions' => [
182		'class' => MenuColumn::class,
183		'menuClass' => BillActionsMenu::class,
184		],
185		]);
186		}
187
188		public function tariffLink($model): string
189		{
190		return Html::a($model->tariff, ['@tariff/view', 'id' => $model->tariff_id]);
191		}
192
193		public function objectTag($model): string
194		{
195		return $model->object ? implode(': ', [$model->class_label, $this->objectLink($model)]) : '';
196		}
197
198		/**
199		* Creates link to object details page.
200		*
201		* @param Bill $model
202		* @return string
203		*/
204		public function objectLink(Bill $model): string
205		{
206		return $model->class === 'device'
		0 ignored issues – show Documentation introduced 2017-06-14 09:38 UTC by Report Bug Copy Issue Report The property `class` does not exist on `object<hipanel\modules\finance\models\Bill>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
207		? Html::a($model->object, ['@server/view', 'id' => $model->object_id])
		0 ignored issues – show Documentation introduced 2017-06-14 09:38 UTC by Report Bug Copy Issue Report The property `object` does not exist on `object<hipanel\modules\finance\models\Bill>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2017-06-14 09:38 UTC by Report Bug Copy Issue Report The property `object_id` does not exist on `object<hipanel\modules\finance\models\Bill>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
208		: Html::tag('b', $model->object);
		0 ignored issues – show Documentation introduced 2017-06-14 09:38 UTC by Report Bug Copy Issue Report The property `object` does not exist on `object<hipanel\modules\finance\models\Bill>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
209		}
210
211		private function formatQuantity(Bill $bill): string
212		{
213		$billQty = $this->quantityFactory->forBill($bill);
214
215		if ($billQty !== null) {
216		return Html::tag('nobr', Html::tag('b', $billQty->format()));
217		}
218
219		return '';
220		}
221		}
222

hiqdev / hipanel-module-finance

Push — master ( b864d9...3fa98b )

BillGridView::objectTag() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like