hipanel\modules\server\widgets\TrafficConsumption

Complexity

Total Complexity

9

Size/Duplication

Total Lines	138
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	clientRegisterCss()	0	4	1
A	renderBlockFooter()	0	3	1
A	run()	0	14	2
A	init()	0	25	3
A	renderBlockHeader()	0	3	1
A	renderCanvasData()	0	30	1

<?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-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\modules\server\widgets;

use dosamigos\chartjs\ChartJs;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\Html;

class TrafficConsumption extends Widget
{
    /**
     * @var array Lable for each [[data]] item. Will be rendered on chart axis.
     * Example:
     *
     * ```php
     *  ['June 2017', 'July 2017']
     * ```
     */
    public $labels;

    /**
     * @var array Array of arrays of the traffic data. Each data point will be rendered on chart
     * Key - traffic type name, must be corresponding with [[consumptionBase]]
     * Value - array of traffic amount values for each period according to the [[lables]]
     *
     * Example:
     * ```php
     * [
     *    'server_traf_in' => [221.2, 312],
     *    'server_traf' => [1232, 3411]
     * ]
     * ```
     */
    public $data = [];

    /**
     * @var string
     */
    public $chartType = 'line';

    /**
     * @var string name of consumption property
     */
    public $consumptionBase = 'server_traf';

    /**
     * @var array Messages which would be shown if data is empty
     */
    protected $emptyMessage;

    /**
     * @var array Legends for datasets
     */
    protected $legends;

    public function init()
    {
        parent::init();

        if ($this->labels === null) {
            throw new InvalidConfigException('Please specify the "labels" property.');
        }

        if ($this->id === null) {
            $this->id = $this->consumptionBase . '_consumption_chart';
        }

        $this->emptyMessage = [
            'server_traf' => Yii::t('hipanel:server', 'Traffic consumption history is not available for this server'),
            'server_traf95' => Yii::t('hipanel:server', 'Bandwidth consumption history is not available for this server'),
        ];

        $this->legends = [
            'server_traf' => Yii::t('hipanel:server', 'Total outgoing traffic, Gb'),
            'server_traf_in' => Yii::t('hipanel:server', 'Total incoming traffic, Gb'),
            'server_traf95' => Yii::t('hipanel:server', '95th percentile for outgoing bandwidth, Mbit/s'),
            'server_traf95_in' => Yii::t('hipanel:server', '95th percentile for incoming bandwidth, Mbit/s'),
        ];

        $this->labels = array_values($this->labels);
    }

    public function run()
    {
        $html = '';
        $this->clientRegisterCss();

        $html .= $this->renderBlockHeader();
        if ($this->data === []) {
            $html .=  $this->emptyMessage[$this->consumptionBase];
        } else {
            $html .=  $this->renderCanvasData();
        }
        $html .=  $this->renderBlockFooter();

        return $html;
    }

    protected function renderBlockHeader()
    {
        return "<div class='row {$this->consumptionBase}-chart-wrapper'><div class='col-md-12'>";
    }

    protected function renderCanvasData()
    {
        return Html::tag('div', ChartJs::widget([
            'id' => $this->id,
            'type' => $this->chartType,
            'data' => [
                'labels' => $this->labels,
                'datasets' => [
                    [
                        'label' => $this->legends[$this->consumptionBase],
                        'backgroundColor' => 'rgba(139, 195, 74, 0.5)',
                        'borderColor' => 'rgba(139, 195, 74, 1)',
                        'pointBackgroundColor' => 'rgba(139, 195, 74, 1)',
                        'pointBorderColor' => '#fff',
                        'data' => (array) $this->data[$this->consumptionBase],
                    ],
                    [
                        'label' => $this->legends["{$this->consumptionBase}_in"],
                        'backgroundColor' => 'rgba(151,187,205,0.5)',
                        'borderColor' => 'rgba(151,187,205,1)',
                        'pointBackgroundColor' => 'rgba(151,187,205,1)',
                        'pointBorderColor' => '#fff',
                        'data' => (array) $this->data["{$this->consumptionBase}_in"],
                    ],
                ],
            ],
            'clientOptions' => [
                'bezierCurve' => false,
                'responsive' => true,
                'maintainAspectRatio' => true,
            ],
        ]));
    }

    protected function renderBlockFooter()
    {
        return '</div></div>';
    }

    protected function clientRegisterCss()
    {
        $view = $this->getView();
        $view->registerCss('
            ul.line-legend {
                list-style: none;
                margin: 0;
                padding: 0;
            }
        ');
    }
}