PrefixGridView::columns() - Code Metrics - Inspection of "Imporved IPAM stuff" - hiqdev/hipanel-module-hosting - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d26825...dc6239 )

by Klochok

created 2020-09-03 15:24 UTC

PrefixGridView::columns() B

↳ Parent: PrefixGridView

Complexity

Conditions	3
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	75
rs	8.5454
c	0
b	0
f	0
cc	3
nc	1
nop	0

How to fix Long Method

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

namespace hipanel\modules\hosting\grid;

use hipanel\grid\BoxedGridView;
use hipanel\grid\RefColumn;
use hipanel\grid\XEditableColumn;
use hipanel\modules\hosting\menus\PrefixActionsMenu;
use hipanel\modules\hosting\models\AddressSearch;
use hipanel\modules\hosting\models\Prefix;
use hiqdev\yii2\menus\grid\MenuColumn;
use Yii;
use yii\helpers\Html;

class PrefixGridView extends BoxedGridView
{
    public function columns()
    {
        return array_merge(parent::columns(), [
            'ip' => [
                'format' => 'html',
                'value' => static function (Prefix $prefix) {
                    return Html::a($prefix->ip, ['@prefix/view', 'id' => $prefix->id], ['class' => 'text-bold']);
<?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.");
        }
    }

}
                },
            ],
            'type' => [
                'class' => RefColumn::class,
                'i18nDictionary' => 'hipanel.hosting.ipam',
                'format' => 'raw',
                'gtype' => 'type,ip_prefix',
            ],
            'vrf' => [
                'class' => RefColumn::class,
                'i18nDictionary' => 'hipanel.hosting.ipam',
                'format' => 'raw',
                'gtype' => 'type,ip_vrf',
            ],
            'role' => [
                'class' => RefColumn::class,
                'i18nDictionary' => 'hipanel.hosting.ipam',
                'format' => 'raw',
                'gtype' => 'type,ip_prefix_role',
            ],
            'site' => [
                'class' => RefColumn::class,
                'i18nDictionary' => 'hipanel.hosting.ipam',
                'format' => 'raw',
                'gtype' => 'type,location',
            ],
            'family' => [
                'class' => FamilyColumn::class,
            ],
            'utilization' => [
                'class' => UtilizationColumn::class,
            ],
            'note' => [
                'class' => XEditableColumn::class,
                'pluginOptions' => [
                    'url' => '@prefix/set-note',
                ],
                'filter' => true,
                'popover' => Yii::t('hipanel', 'Make any notes for your convenience'),
            ],
            'aggregate' => [
                'attribute' => 'aggregate',
                'format' => 'html',
                'value' => static function ($prefix): string {
                    return $prefix->aggregate ?
                        Html::a($prefix->aggregate, ['@aggregate/view', 'id' => $prefix->aggregate_id]) :
                        '';
                },
            ],
            'ip_count' => [
                'attribute' => 'ip_count',
                'label' => Yii::t('hipanel.hosting.ipam', 'IP Addresses'),
                'format' => 'html',
                'value' => static function ($prefix): string {
                    return $prefix->ip_count > 0 ?
                        Html::a('IP Addresses (' . $prefix->ip_count . ')', [
                            '@address/index', (new AddressSearch)->formName() => ['ip_cnts' => $prefix->ip],
                        ], ['class' => 'btn btn-success btn-flat btn-sm']) :
                        $prefix->ip_count;
                },
            ],
            'actions' => [
                'class' => MenuColumn::class,
                'contentOptions' => ['style' => 'width: 1%; white-space:nowrap;'],
                'menuClass' => PrefixActionsMenu::class,
            ],
        ]);
    }
}


1			<?php
2			/**
3			* Hosting Plugin for HiPanel
4			*
5			* @link https://github.com/hiqdev/hipanel-module-hosting
6			* @package hipanel-module-hosting
7			* @license BSD-3-Clause
8			* @copyright Copyright (c) 2015-2019, HiQDev (http://hiqdev.com/)
9			*/
10
11			namespace hipanel\modules\hosting\grid;
12
13			use hipanel\grid\BoxedGridView;
14			use hipanel\grid\RefColumn;
15			use hipanel\grid\XEditableColumn;
16			use hipanel\modules\hosting\menus\PrefixActionsMenu;
17			use hipanel\modules\hosting\models\AddressSearch;
18			use hipanel\modules\hosting\models\Prefix;
19			use hiqdev\yii2\menus\grid\MenuColumn;
20			use Yii;
21			use yii\helpers\Html;
22
23			class PrefixGridView extends BoxedGridView
24			{
25			public function columns()
26			{
27			return array_merge(parent::columns(), [
28			'ip' => [
29			'format' => 'html',
30			'value' => static function (Prefix $prefix) {
31			return Html::a($prefix->ip, ['@prefix/view', 'id' => $prefix->id], ['class' => 'text-bold']);
			0 ignored issues – show Documentation introduced 2020-08-20 14:10 UTC by Report Bug Copy Issue Report The property `ip` does not exist on `object<hipanel\modules\hosting\models\Prefix>`. 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 2020-08-20 14:10 UTC by Report Bug Copy Issue Report The property `id` does not exist on `object<hipanel\modules\hosting\models\Prefix>`. 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...
32			},
33			],
34			'type' => [
35			'class' => RefColumn::class,
36			'i18nDictionary' => 'hipanel.hosting.ipam',
37			'format' => 'raw',
38			'gtype' => 'type,ip_prefix',
39			],
40			'vrf' => [
41			'class' => RefColumn::class,
42			'i18nDictionary' => 'hipanel.hosting.ipam',
43			'format' => 'raw',
44			'gtype' => 'type,ip_vrf',
45			],
46			'role' => [
47			'class' => RefColumn::class,
48			'i18nDictionary' => 'hipanel.hosting.ipam',
49			'format' => 'raw',
50			'gtype' => 'type,ip_prefix_role',
51			],
52			'site' => [
53			'class' => RefColumn::class,
54			'i18nDictionary' => 'hipanel.hosting.ipam',
55			'format' => 'raw',
56			'gtype' => 'type,location',
57			],
58			'family' => [
59			'class' => FamilyColumn::class,
60			],
61			'utilization' => [
62			'class' => UtilizationColumn::class,
63			],
64			'note' => [
65			'class' => XEditableColumn::class,
66			'pluginOptions' => [
67			'url' => '@prefix/set-note',
68			],
69			'filter' => true,
70			'popover' => Yii::t('hipanel', 'Make any notes for your convenience'),
71			],
72			'aggregate' => [
73			'attribute' => 'aggregate',
74			'format' => 'html',
75			'value' => static function ($prefix): string {
76			return $prefix->aggregate ?
77			Html::a($prefix->aggregate, ['@aggregate/view', 'id' => $prefix->aggregate_id]) :
78			'';
79			},
80			],
81			'ip_count' => [
82			'attribute' => 'ip_count',
83			'label' => Yii::t('hipanel.hosting.ipam', 'IP Addresses'),
84			'format' => 'html',
85			'value' => static function ($prefix): string {
86			return $prefix->ip_count > 0 ?
87			Html::a('IP Addresses (' . $prefix->ip_count . ')', [
88			'@address/index', (new AddressSearch)->formName() => ['ip_cnts' => $prefix->ip],
89			], ['class' => 'btn btn-success btn-flat btn-sm']) :
90			$prefix->ip_count;
91			},
92			],
93			'actions' => [
94			'class' => MenuColumn::class,
95			'contentOptions' => ['style' => 'width: 1%; white-space:nowrap;'],
96			'menuClass' => PrefixActionsMenu::class,
97			],
98			]);
99			}
100			}
101

hiqdev / hipanel-module-hosting

Push — master ( d26825...dc6239 )

PrefixGridView::columns() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like