ServerGridView::renderSwitchPort() - Code Metrics - Inspection of "added admin representation, switches displaying an..." - hiqdev/hipanel-module-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 142faa...f70da4 )

by Andrii

created 2016-06-24 18:30 UTC

ServerGridView::renderSwitchPort() A

↳ Parent: ServerGridView

Complexity

Conditions	4
Paths	8

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	13
ccs	0
cts	11
cp	0
rs	9.2
cc	4
eloc	9
nc	8
nop	1
crap	20

<?php

/*
 * Server module for HiPanel
 *
 * @link      https://github.com/hiqdev/hipanel-module-server
 * @package   hipanel-module-server
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\grid;

use hipanel\grid\ActionColumn;
use hipanel\grid\MainColumn;
use hipanel\grid\RefColumn;
use hipanel\grid\XEditableColumn;
use hipanel\helpers\Url;
use hipanel\modules\server\widgets\DiscountFormatter;
use hipanel\modules\server\widgets\Expires;
use hipanel\modules\server\widgets\OSFormatter;
use hipanel\modules\server\widgets\State;
use hipanel\widgets\ArraySpoiler;
use Yii;
use yii\helpers\ArrayHelper;
use yii\helpers\Html;

class ServerGridView extends \hipanel\grid\BoxedGridView
{
    /**
     * @var array
     */
    public static $osImages;

    public static function setOsImages($osImages)
    {
        static::$osImages = $osImages;
    }

    public static function formatTariff($model)
    {
        if (Yii::$app->user->can('support')) {
            if ($model->parent_tariff && $model->parent_tariff !== $model->tariff) {
                return Html::tag('abbr', $model->parent_tariff, ['title' => $model->tariff, 'data-toggle' => 'tooltip']);
            } else {
                return $model->tariff;
            }
        } else {
            return !empty($model->parent_tariff) ? $model->parent_tariff : $model->tariff;
        }
    }

    public static function defaultColumns()
    {
        $osImages = self::$osImages;

        return [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            'server' => [
                'class' => MainColumn::class,
                'attribute' => 'name',
                'filterAttribute' => 'name_like',
                'note' => Yii::$app->user->can('support') ? 'label' : 'note',
                'noteOptions' => [
                    'url' => Yii::$app->user->can('support') ? Url::to('set-label') : Url::to('set-note'),
                ],
            ],
            'dc' => [
                'attribute' => 'dc',
                'filter' => false,
            ],
            'state' => [
                'class' => RefColumn::class,
                'i18nDictionary' => 'hipanel/server',
                'format' => 'raw',
                'gtype' => 'state,device',
                'value' => function ($model) {
                    $html = State::widget(compact('model'));
                    if ($model->status_time) {
                        $html .= ' '. Html::tag('nobr', Yii::t('hipanel/server', 'since {date}', ['date' => Yii::$app->formatter->asDate($model->status_time)]));
                    }
                    return $html;
                },
            ],
            'panel' => [
                'attribute' => 'panel',
                'format' => 'text',
                'contentOptions' => ['class' => 'text-uppercase'],
                'value' => function ($model) {
                    return $model->panel ? Yii::t('hipanel/server/panel', $model->panel) : Yii::t('hipanel/server/panel', 'No control panel');
                },
            ],
            'os' => [
                'attribute' => 'os',
                'format' => 'raw',
                'value' => function ($model) use ($osImages) {
                    return OSFormatter::widget([
                        'osimages' => $osImages,
                        'imageName' => $model->osimage,
                    ]);
                },
            ],
            'os_and_panel' => [
                'attribute' => 'os',
                'format' => 'raw',
                'value' => function ($model) use ($osImages) {
                    $html = OSFormatter::widget([
                        'osimages' => $osImages,
                        'imageName' => $model->osimage,
                    ]);
                    $html .= ' ' . $model->panel ?: '';
                    return $html;
                },
            ],
            'tariff_and_discount' => [
                'attribute' => 'tariff',
                'format' => 'raw',
                'value' => function ($model) {

                    return self::formatTariff($model) . ' ' . DiscountFormatter::widget([
                        'current' => $model->discounts['fee']['current'],
                        'next' => $model->discounts['fee']['next'],
                    ]);
                },
            ],
            'discount' => [
                'attribute' => 'discount',
                'label' => Yii::t('hipanel/server', 'Discount'),
                'format' => 'raw',
                'headerOptions' => ['style' => 'width: 1em'],
                'value' => function ($model) {

                    return DiscountFormatter::widget([
                        'current' => $model->discounts['fee']['current'],
                        'next' => $model->discounts['fee']['next'],
                    ]);
                },
            ],
            'actions' => [
                'class' => ActionColumn::class,
                'template' => '{view}',
                'header' => Yii::t('hipanel', 'Actions'),
            ],
            'expires' => [
                'filter' => false,
                'format' => 'raw',
                'headerOptions' => ['style' => 'width: 1em'],
                'value' => function ($model) {
                    return Expires::widget(compact('model'));
                },
            ],
            'tariff' => [
                'format' => 'raw',
                'attribute' => 'tariff',
                'value' => function ($model) {
                    return self::formatTariff($model);
                },
            ],
            'tariff_note' => [
                'attribute' => 'tariff_note',
                'value' => function ($model) {


                },
            ],
            'ip' => [
                'filter' => false,
            ],
            'mac' => [
                'filter' => false,
            ],
            'ips' => [
                'format' => 'raw',
                'attribute' => 'ips',
                'filter' => false,
                'value' => function ($model) {
                    return ArraySpoiler::widget([
                        'data' => ArrayHelper::getColumn($model->ips, 'ip'),
                        'delimiter' => '<br />',
                        'visibleCount' => 3,
                        'button' => ['popoverOptions' => ['html' => true]],
                    ]);
                },
            ],
            'sale_time' => [
                'attribute' => 'sale_time',
                'format' => 'date',
            ],
            'note' => [
                'class' => XEditableColumn::class,
                'pluginOptions' => [
                    'url'       => Url::to('set-note'),
                ],
                'widgetOptions' => [
                    'linkOptions' => [
                        'data-type' => 'textarea',
                    ],
                ],
            ],
            'label' => [
                'class' => XEditableColumn::class,
                'visible' => Yii::$app->user->can('support'),
                'pluginOptions' => [
                    'url'       => Url::to('set-label'),
                ],
                'widgetOptions' => [
                    'linkOptions' => [
                        'data-type' => 'textarea',
                    ],
                ],
            ],
            'type' => [
                'format' => 'html',
                'filter' => false,
                'value'  => function ($model) {
                    return $model->type_label;
                },
            ],
            'rack' => [
                'format' => 'html',
                'filterAttribute' => 'rack_like',
                'value'  => function ($model) {
                    return $model->switches['rack']['switch'];
                },
            ],
            'net' => [
                'format' => 'html',
                'filter' => false,
                'value'  => function ($model) {
                    return static::renderSwitchPort($model->switches['net']);
                },
            ],
            'kvm' => [
                'format' => 'html',
                'filter' => false,
                'value'  => function ($model) {
                    return static::renderSwitchPort($model->switches['kvm']);
                },
            ],
            'pdu' => [
                'format' => 'html',
                'filter' => false,
                'value'  => function ($model) {
                    return static::renderSwitchPort($model->switches['pdu']);
                },
            ],
            'ipmi' => [
                'format' => 'raw',
                'filter' => false,
                'value'  => function ($model) {
                    $ipmi = $model->switches['ipmi']['device_ip'];
                    $link = $ipmi ? Html::a($ipmi, "http://$ipmi/", ['target' => '_blank']) . ' ' : '';
                    return $link . static::renderSwitchPort($model->switches['ipmi']);
                },
            ],
        ];
    }

    public static function renderSwitchPort($data)
    {
        $label  = $data['switch_label'];
        $inn    = $data['switch_inn'];
        $name   = $data['switch'];
        $port   = $data['port'];

        $inn    = $inn ? "($inn)" : '';
        $main   = $port ? "$name:$port" : $name;
        $main   = $main ? "<b>$main</b>" : '';

        return "$inn $main $label";
    }

    public static function defaultRepresentations()
    {
        return [
            'common' => [
                'label'   => Yii::t('hipanel', 'common'),
                'columns' => [
                    'checkbox',
                    'server', 'client_id', 'seller_id',
                    'ips', 'state', 'expires',
                    'tariff_and_discount',
                ],
            ],
            'manager' => Yii::$app->user->can('support') ? [
                'label'   => Yii::t('hipanel/server', 'manager'),
                'columns' => [
                    'checkbox', 'client_id',
                    'rack', 'dc', 'server', 'tariff', 'hwsummary',
                ],
            ] : null,
            'admin' => Yii::$app->user->can('support') ? [
                'label'   => Yii::t('hipanel/server', 'admin'),
                'columns' => [
                    'checkbox', 'dc', 'server', 'type',
                    'net', 'kvm', 'ipmi', 'pdu', 'ip', 'mac',
                ],
            ] : null,
        ];
    }
}


1		<?php
2
3		/*
4		* Server module for HiPanel
5		*
6		* @link https://github.com/hiqdev/hipanel-module-server
7		* @package hipanel-module-server
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hipanel\modules\server\grid;
13
14		use hipanel\grid\ActionColumn;
15		use hipanel\grid\MainColumn;
16		use hipanel\grid\RefColumn;
17		use hipanel\grid\XEditableColumn;
18		use hipanel\helpers\Url;
19		use hipanel\modules\server\widgets\DiscountFormatter;
20		use hipanel\modules\server\widgets\Expires;
21		use hipanel\modules\server\widgets\OSFormatter;
22		use hipanel\modules\server\widgets\State;
23		use hipanel\widgets\ArraySpoiler;
24		use Yii;
25		use yii\helpers\ArrayHelper;
26		use yii\helpers\Html;
27
28		class ServerGridView extends \hipanel\grid\BoxedGridView
29		{
30		/**
31		* @var array
32		*/
33		public static $osImages;
34
35		public static function setOsImages($osImages)
36		{
37		static::$osImages = $osImages;
38		}
39
40		public static function formatTariff($model)
41		{
42		if (Yii::$app->user->can('support')) {
43		if ($model->parent_tariff && $model->parent_tariff !== $model->tariff) {
44		return Html::tag('abbr', $model->parent_tariff, ['title' => $model->tariff, 'data-toggle' => 'tooltip']);
45		} else {
46		return $model->tariff;
47		}
48		} else {
49		return !empty($model->parent_tariff) ? $model->parent_tariff : $model->tariff;
50		}
51		}
52
53		public static function defaultColumns()
54		{
55		$osImages = self::$osImages;
56
57		return [
		0 ignored issues – show Bug Best Practice introduced 2016-06-24 18:47 UTC by Report Bug Copy Issue Report The return type of `return array('server' =>...switches['ipmi']); }));` (`array<string,array>`) is incompatible with the return type of the parent method `hipanel\grid\GridView::defaultColumns` of type `array<string,array>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
58		'server' => [
59		'class' => MainColumn::class,
60		'attribute' => 'name',
61		'filterAttribute' => 'name_like',
62		'note' => Yii::$app->user->can('support') ? 'label' : 'note',
63		'noteOptions' => [
64		'url' => Yii::$app->user->can('support') ? Url::to('set-label') : Url::to('set-note'),
65		],
66		],
67		'dc' => [
68		'attribute' => 'dc',
69		'filter' => false,
70		],
71		'state' => [
72		'class' => RefColumn::class,
73		'i18nDictionary' => 'hipanel/server',
74		'format' => 'raw',
75		'gtype' => 'state,device',
76		'value' => function ($model) {
77		$html = State::widget(compact('model'));
78		if ($model->status_time) {
79		$html .= ' '. Html::tag('nobr', Yii::t('hipanel/server', 'since {date}', ['date' => Yii::$app->formatter->asDate($model->status_time)]));
80		}
81		return $html;
82		},
83		],
84		'panel' => [
85		'attribute' => 'panel',
86		'format' => 'text',
87		'contentOptions' => ['class' => 'text-uppercase'],
88		'value' => function ($model) {
89		return $model->panel ? Yii::t('hipanel/server/panel', $model->panel) : Yii::t('hipanel/server/panel', 'No control panel');
90		},
91		],
92		'os' => [
93		'attribute' => 'os',
94		'format' => 'raw',
95		'value' => function ($model) use ($osImages) {
96		return OSFormatter::widget([
97		'osimages' => $osImages,
98		'imageName' => $model->osimage,
99		]);
100		},
101		],
102		'os_and_panel' => [
103		'attribute' => 'os',
104		'format' => 'raw',
105		'value' => function ($model) use ($osImages) {
106		$html = OSFormatter::widget([
107		'osimages' => $osImages,
108		'imageName' => $model->osimage,
109		]);
110		$html .= ' ' . $model->panel ?: '';
111		return $html;
112		},
113		],
114		'tariff_and_discount' => [
115		'attribute' => 'tariff',
116		'format' => 'raw',
117	View Code Duplication	'value' => function ($model) {
		0 ignored issues – show Duplication introduced 2016-04-06 14:30 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...
118		return self::formatTariff($model) . ' ' . DiscountFormatter::widget([
119		'current' => $model->discounts['fee']['current'],
120		'next' => $model->discounts['fee']['next'],
121		]);
122		},
123		],
124		'discount' => [
125		'attribute' => 'discount',
126		'label' => Yii::t('hipanel/server', 'Discount'),
127		'format' => 'raw',
128		'headerOptions' => ['style' => 'width: 1em'],
129	View Code Duplication	'value' => function ($model) {
		0 ignored issues – show Duplication introduced 2016-04-06 14:30 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...
130		return DiscountFormatter::widget([
131		'current' => $model->discounts['fee']['current'],
132		'next' => $model->discounts['fee']['next'],
133		]);
134		},
135		],
136		'actions' => [
137		'class' => ActionColumn::class,
138		'template' => '{view}',
139		'header' => Yii::t('hipanel', 'Actions'),
140		],
141		'expires' => [
142		'filter' => false,
143		'format' => 'raw',
144		'headerOptions' => ['style' => 'width: 1em'],
145		'value' => function ($model) {
146		return Expires::widget(compact('model'));
147		},
148		],
149		'tariff' => [
150		'format' => 'raw',
151		'attribute' => 'tariff',
152		'value' => function ($model) {
153		return self::formatTariff($model);
154		},
155		],
156		'tariff_note' => [
157		'attribute' => 'tariff_note',
158		'value' => function ($model) {
		0 ignored issues – show Unused Code introduced 2016-04-06 14:30 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...
159
160		},
161		],
162		'ip' => [
163		'filter' => false,
164		],
165		'mac' => [
166		'filter' => false,
167		],
168		'ips' => [
169		'format' => 'raw',
170		'attribute' => 'ips',
171		'filter' => false,
172		'value' => function ($model) {
173		return ArraySpoiler::widget([
174		'data' => ArrayHelper::getColumn($model->ips, 'ip'),
175		'delimiter' => '<br />',
176		'visibleCount' => 3,
177		'button' => ['popoverOptions' => ['html' => true]],
178		]);
179		},
180		],
181		'sale_time' => [
182		'attribute' => 'sale_time',
183		'format' => 'date',
184		],
185		'note' => [
186		'class' => XEditableColumn::class,
187		'pluginOptions' => [
188		'url' => Url::to('set-note'),
189		],
190		'widgetOptions' => [
191		'linkOptions' => [
192		'data-type' => 'textarea',
193		],
194		],
195		],
196		'label' => [
197		'class' => XEditableColumn::class,
198		'visible' => Yii::$app->user->can('support'),
199		'pluginOptions' => [
200		'url' => Url::to('set-label'),
201		],
202		'widgetOptions' => [
203		'linkOptions' => [
204		'data-type' => 'textarea',
205		],
206		],
207		],
208		'type' => [
209		'format' => 'html',
210		'filter' => false,
211		'value' => function ($model) {
212		return $model->type_label;
213		},
214		],
215		'rack' => [
216		'format' => 'html',
217		'filterAttribute' => 'rack_like',
218		'value' => function ($model) {
219		return $model->switches['rack']['switch'];
220		},
221		],
222		'net' => [
223		'format' => 'html',
224		'filter' => false,
225		'value' => function ($model) {
226		return static::renderSwitchPort($model->switches['net']);
227		},
228		],
229		'kvm' => [
230		'format' => 'html',
231		'filter' => false,
232		'value' => function ($model) {
233		return static::renderSwitchPort($model->switches['kvm']);
234		},
235		],
236		'pdu' => [
237		'format' => 'html',
238		'filter' => false,
239		'value' => function ($model) {
240		return static::renderSwitchPort($model->switches['pdu']);
241		},
242		],
243		'ipmi' => [
244		'format' => 'raw',
245		'filter' => false,
246		'value' => function ($model) {
247		$ipmi = $model->switches['ipmi']['device_ip'];
248		$link = $ipmi ? Html::a($ipmi, "http://$ipmi/", ['target' => '_blank']) . ' ' : '';
249		return $link . static::renderSwitchPort($model->switches['ipmi']);
250		},
251		],
252		];
253		}
254
255		public static function renderSwitchPort($data)
256		{
257		$label = $data['switch_label'];
258		$inn = $data['switch_inn'];
259		$name = $data['switch'];
260		$port = $data['port'];
261
262		$inn = $inn ? "($inn)" : '';
263		$main = $port ? "$name:$port" : $name;
264		$main = $main ? "<b>$main</b>" : '';
265
266		return "$inn $main $label";
267		}
268
269		public static function defaultRepresentations()
270		{
271		return [
272		'common' => [
273		'label' => Yii::t('hipanel', 'common'),
274		'columns' => [
275		'checkbox',
276		'server', 'client_id', 'seller_id',
277		'ips', 'state', 'expires',
278		'tariff_and_discount',
279		],
280		],
281		'manager' => Yii::$app->user->can('support') ? [
282		'label' => Yii::t('hipanel/server', 'manager'),
283		'columns' => [
284		'checkbox', 'client_id',
285		'rack', 'dc', 'server', 'tariff', 'hwsummary',
286		],
287		] : null,
288		'admin' => Yii::$app->user->can('support') ? [
289		'label' => Yii::t('hipanel/server', 'admin'),
290		'columns' => [
291		'checkbox', 'dc', 'server', 'type',
292		'net', 'kvm', 'ipmi', 'pdu', 'ip', 'mac',
293		],
294		] : null,
295		];
296		}
297		}
298

hiqdev / hipanel-module-server

Push — master ( 142faa...f70da4 )

ServerGridView::renderSwitchPort() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like