dosamigos\chartjs\ChartJs

Complexity

Total Complexity

7

Size/Duplication

Total Lines	90
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

83.87%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	10	3
A	run()	0	5	1
A	registerClientScript()	0	18	3

<?php

/*
 * This file is part of the 2amigos/yii2-chartjs-widget project.
 * (c) 2amigOS! <http://2amigos.us/>
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace dosamigos\chartjs;

use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\web\JsExpression;

/**
 *
 * Chart renders a canvas ChartJs plugin widget.
 */
class ChartJs extends Widget
{
    /**
     * @var array the HTML attributes for the widget container tag.
     */
    public $options = [];
    /**
     * @var array the options for the underlying ChartJs JS plugin.
     *            Please refer to the corresponding ChartJs type plugin Web page for possible options.
     *            For example, [this page](http://www.chartjs.org/docs/#lineChart) shows
     *            how to use the "Line chart" plugin.
     */
    public $clientOptions = [];
    /**
     * @var array the datasets configuration options and data to display on the chart.
     *            See [its documentation](http://www.chartjs.org/docs/) for the different options.
     */
    public $data = [];
    /**
     * @var string the type of chart to display. The possible options are:
     *             - "Line" : A line chart is a way of plotting data points on a line. Often, it is used to show trend data, and the
     *             comparison of two data sets.
     *             - "Bar" : A bar chart is a way of showing data as bars. It is sometimes used to show trend data, and the
     *             comparison of multiple data sets side by side.
     *             - "Radar" : A radar chart is a way of showing multiple data points and the variation between them. They are often
     *             useful for comparing the points of two or more different data sets
     *             - "PolarArea" : Polar area charts are similar to pie charts, but each segment has the same angle - the radius of
     *             the segment differs depending on the value. This type of chart is often useful when we want to show a comparison
     *             data similar to a pie chart, but also show a scale of values for context.
     *             - "Pie" : Pie charts are probably the most commonly used chart there are. They are divided into segments, the arc
     *             of each segment shows a the proportional value of each piece of data.
     *             - "Doughnut" : Doughnut charts are similar to pie charts, however they have the centre cut out, and are therefore
     *             shaped more like a doughnut than a pie!
     */
    public $type;
    /**
     * @var array the plugin objects allowing to assign custom callback functions to Chart events.
     *            See [plugins & events documentation]
     *            (http://www.chartjs.org/docs/latest/developers/plugins.html#plugin-core-api).
     */
    public $plugins = [];

    /**
     * Initializes the widget.
     * This method will register the bootstrap asset bundle. If you override this method,
     * make sure you call the parent implementation first.
     * @throws InvalidConfigException
     */
    public function init()
    {
        parent::init();
        if ($this->type === null) {
            throw new InvalidConfigException("The 'type' option is required");
        }
        if (!isset($this->options['id'])) {
            $this->options['id'] = $this->getId();
        }
    }

    /**
     * Renders the widget.
     */
    public function run()
    {
        echo Html::tag('canvas', '', $this->options);
        $this->registerClientScript();
    }

    /**
     * Registers the required js files and script to initialize ChartJS plugin
     */
    protected function registerClientScript(): void
    {
        $id = $this->options['id'];
        $view = $this->getView();
        ChartJsAsset::register($view);

        $config = Json::encode(
            [
                'type' => $this->type,
                'data' => $this->data ?: new JsExpression('{}'),
                'options' => $this->clientOptions ?: new JsExpression('{}'),
                'plugins' => $this->plugins
            ]
        );

        $js = ";var chartJS_{$id} = new Chart($('#{$id}'),{$config});";
        $view->registerJs($js);
    }
}