ChartOutput::endCallback() - Code Metrics - Inspection of "Improve QA" - cmen/CMENGoogleChartsBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Christophe

created 2019-12-06 15:54 UTC

ChartOutput::endCallback() A

↳ Parent: ChartOutput

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace CMEN\GoogleChartsBundle\Output\Javascript;

use CMEN\GoogleChartsBundle\Exception\GoogleChartsException;
use CMEN\GoogleChartsBundle\GoogleCharts\Chart;
use CMEN\GoogleChartsBundle\GoogleCharts\Charts\Diff\DiffChart;
use CMEN\GoogleChartsBundle\Output\AbstractChartOutput;
use CMEN\GoogleChartsBundle\Output\DataOutputInterface;
use CMEN\GoogleChartsBundle\Output\EventsOutputInterface;
use CMEN\GoogleChartsBundle\Output\OptionsOutputInterface;

/**
 * @author Christophe Meneses
 */
class ChartOutput extends AbstractChartOutput
{
    /** @var OptionsOutputInterface */
    private $optionsOutput;

    /** @var DataOutputInterface */
    private $dataOutput;

    /** @var EventsOutputInterface */
    private $eventsOutput;

    /**
     * ChartOutput constructor.
     *
     * @param string $version
     * @param string $language
     */
    public function __construct(
        $version,
        $language,
        OptionsOutputInterface $optionsOutput,
        DataOutputInterface $dataOutput,
        EventsOutputInterface $eventsOutput
    ) {
        parent::__construct($version, $language);

        $this->optionsOutput = $optionsOutput;
        $this->dataOutput = $dataOutput;
        $this->eventsOutput = $eventsOutput;
    }

    public function startChart(Chart $chart)
    {
        if (null === $chart->getElementID()) {
            throw new GoogleChartsException('Container is not defined.');
        }

        $js = 'var '.$chart->getName().' = new google.'.$chart->getLibrary().'.'.$chart->getType().
            '(document.getElementById("'.$chart->getElementID().'"));';

        if (!$chart instanceof DiffChart) {
            $js .= $this->dataOutput->draw($chart->getData(), $chart->getDataName());
        } else {
            $js .= $this->dataOutput->draw($chart->getOldChart()->getData(), 'old_'.$chart->getDataName()).
                $this->dataOutput->draw($chart->getNewChart()->getData(), 'new_'.$chart->getDataName()).
                'var '.$chart->getDataName().' = '.$chart->getName().
                '.computeDiff(old_'.$chart->getDataName().',
                 new_'.$chart->getDataName().');';
        }

        $js .= $this->optionsOutput->draw($chart->getOptions(), $chart->getOptionsName());

        return $js;
    }

    public function endChart(Chart $chart)
    {
        if ('visualization' == $chart->getLibrary()) {
            $options = $chart->getOptionsName();
        } else {
            /* Options conversion for material charts */
            $options = 'google.'.$chart->getLibrary().'.'.$chart->getType().
                '.convertOptions('.$chart->getOptionsName().')';
        }

        return $this->eventsOutput->draw($chart->getEvents(), $chart->getName()).$chart->getName().
            '.draw('.$chart->getDataName().', '.$options.');';
    }

    public function startCharts($charts, $elementsID = null)
    {
        if ($charts instanceof Chart) {
            $charts = [$charts];

            if ($elementsID) {
                if (!is_string($elementsID)) {
                    throw new GoogleChartsException('A string is expected for HTML element ID.');
                }

                $elementsID = [$elementsID];
            }
        } elseif (is_array($charts) && !empty($charts)) {
            $this->checkChartsTypes($charts);

            if (null !== $elementsID) {
                if (!is_array($elementsID)) {
                    throw new GoogleChartsException('An array of string is expected for HTML elements IDs.');
                }

                $this->checkElementsId($charts, $elementsID);
            }
        } else {
            throw new GoogleChartsException('An instance of Chart or an array of Chart is expected.');
        }

        $packages = [];
        $drawChartName = '';
        for ($i = 0; $i < count($charts); ++$i) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
            if ($elementsID) {
                $charts[$i]->setElementID($elementsID[$i]);
            }

            if (!in_array($charts[$i]->getPackage(), $packages)) {
                $packages[] = $charts[$i]->getPackage();
            }
            $drawChartName .= $charts[$i]->getElementID();
        }

        $js = $this->loadLibraries($packages);

        $js .= $this->startCallback('drawChart'.ucfirst(md5($drawChartName)));

        foreach ($charts as $chart) {
            $js .= $this->startChart($chart);
        }

        return $js;
    }

    public function endCharts($charts)
    {
        if ($charts instanceof Chart) {
            $js = $this->endChart($charts).$this->endCallback();
        } elseif (is_array($charts) && !empty($charts)) {
            $this->checkChartsTypes($charts);

            $js = '';
            foreach ($charts as $chart) {
                $js .= $this->endChart($chart);
            }

            $js .= $this->endCallback();
        } else {
            throw new GoogleChartsException('An instance of Chart or an array of Chart is expected.');
        }

        return $js;
    }

    public function fullCharts($charts, $elementsID = null)
    {
        return $this->startCharts($charts, $elementsID).$this->endCharts($charts);
    }

    public function loadLibraries(array $packages)
    {
        array_walk($packages, function (&$item) {
            $item = "'".$item."'";
        });

        ($this->language) ? $language = ", language: '".$this->language."'" : $language = '';

        $load = "'".$this->version."', {packages:[".implode(',', $packages).']'.$language.'}';

        return "google.charts.load($load);";
    }

    public function startCallback($name)
    {
        return "google.charts.setOnLoadCallback($name); function $name() {";
    }

    public function endCallback()
    {
        return '}';
    }
}


1		<?php
2
3		namespace CMEN\GoogleChartsBundle\Output\Javascript;
4
5		use CMEN\GoogleChartsBundle\Exception\GoogleChartsException;
6		use CMEN\GoogleChartsBundle\GoogleCharts\Chart;
7		use CMEN\GoogleChartsBundle\GoogleCharts\Charts\Diff\DiffChart;
8		use CMEN\GoogleChartsBundle\Output\AbstractChartOutput;
9		use CMEN\GoogleChartsBundle\Output\DataOutputInterface;
10		use CMEN\GoogleChartsBundle\Output\EventsOutputInterface;
11		use CMEN\GoogleChartsBundle\Output\OptionsOutputInterface;
12
13		/**
14		* @author Christophe Meneses
15		*/
16		class ChartOutput extends AbstractChartOutput
17		{
18		/** @var OptionsOutputInterface */
19		private $optionsOutput;
20
21		/** @var DataOutputInterface */
22		private $dataOutput;
23
24		/** @var EventsOutputInterface */
25		private $eventsOutput;
26
27		/**
28		* ChartOutput constructor.
29		*
30		* @param string $version
31		* @param string $language
32		*/
33	14	public function __construct(
34		$version,
35		$language,
36		OptionsOutputInterface $optionsOutput,
37		DataOutputInterface $dataOutput,
38		EventsOutputInterface $eventsOutput
39		) {
40	14	parent::__construct($version, $language);
41
42	14	$this->optionsOutput = $optionsOutput;
43	14	$this->dataOutput = $dataOutput;
44	14	$this->eventsOutput = $eventsOutput;
45	14	}
46
47	5	public function startChart(Chart $chart)
48		{
49	5	if (null === $chart->getElementID()) {
50	1	throw new GoogleChartsException('Container is not defined.');
51		}
52
53	4	$js = 'var '.$chart->getName().' = new google.'.$chart->getLibrary().'.'.$chart->getType().
54	4	'(document.getElementById("'.$chart->getElementID().'"));';
55
56	4	if (!$chart instanceof DiffChart) {
57	4	$js .= $this->dataOutput->draw($chart->getData(), $chart->getDataName());
58		} else {
59		$js .= $this->dataOutput->draw($chart->getOldChart()->getData(), 'old_'.$chart->getDataName()).
60		$this->dataOutput->draw($chart->getNewChart()->getData(), 'new_'.$chart->getDataName()).
61		'var '.$chart->getDataName().' = '.$chart->getName().
62		'.computeDiff(old_'.$chart->getDataName().',
63		new_'.$chart->getDataName().');';
64		}
65
66	4	$js .= $this->optionsOutput->draw($chart->getOptions(), $chart->getOptionsName());
67
68	4	return $js;
69		}
70
71	4	public function endChart(Chart $chart)
72		{
73	4	if ('visualization' == $chart->getLibrary()) {
74	4	$options = $chart->getOptionsName();
75		} else {
76		/* Options conversion for material charts */
77		$options = 'google.'.$chart->getLibrary().'.'.$chart->getType().
78		'.convertOptions('.$chart->getOptionsName().')';
79		}
80
81	4	return $this->eventsOutput->draw($chart->getEvents(), $chart->getName()).$chart->getName().
82	4	'.draw('.$chart->getDataName().', '.$options.');';
83		}
84
85	10	public function startCharts($charts, $elementsID = null)
86		{
87	10	if ($charts instanceof Chart) {
88	5	$charts = [$charts];
89
90	5	if ($elementsID) {
91	1	if (!is_string($elementsID)) {
92	1	throw new GoogleChartsException('A string is expected for HTML element ID.');
93		}
94
95	4	$elementsID = [$elementsID];
96		}
97	5	} elseif (is_array($charts) && !empty($charts)) {
98	4	$this->checkChartsTypes($charts);
99
100	3	if (null !== $elementsID) {
101	3	if (!is_array($elementsID)) {
102	1	throw new GoogleChartsException('An array of string is expected for HTML elements IDs.');
103		}
104
105	2	$this->checkElementsId($charts, $elementsID);
106		}
107		} else {
108	1	throw new GoogleChartsException('An instance of Chart or an array of Chart is expected.');
109		}
110
111	4	$packages = [];
112	4	$drawChartName = '';
113	4	for ($i = 0; $i < count($charts); ++$i) {
		0 ignored issues – show Performance Best Practice introduced 2019-12-06 15:40 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
114	4	if ($elementsID) {
115		$charts[$i]->setElementID($elementsID[$i]);
116		}
117
118	4	if (!in_array($charts[$i]->getPackage(), $packages)) {
119	4	$packages[] = $charts[$i]->getPackage();
120		}
121	4	$drawChartName .= $charts[$i]->getElementID();
122		}
123
124	4	$js = $this->loadLibraries($packages);
125
126	4	$js .= $this->startCallback('drawChart'.ucfirst(md5($drawChartName)));
127
128	4	foreach ($charts as $chart) {
129	4	$js .= $this->startChart($chart);
130		}
131
132	4	return $js;
133		}
134
135	4	public function endCharts($charts)
136		{
137	4	if ($charts instanceof Chart) {
138	4	$js = $this->endChart($charts).$this->endCallback();
139		} elseif (is_array($charts) && !empty($charts)) {
140		$this->checkChartsTypes($charts);
141
142		$js = '';
143		foreach ($charts as $chart) {
144		$js .= $this->endChart($chart);
145		}
146
147		$js .= $this->endCallback();
148		} else {
149		throw new GoogleChartsException('An instance of Chart or an array of Chart is expected.');
150		}
151
152	4	return $js;
153		}
154
155	4	public function fullCharts($charts, $elementsID = null)
156		{
157	4	return $this->startCharts($charts, $elementsID).$this->endCharts($charts);
158		}
159
160		public function loadLibraries(array $packages)
161		{
162	5	array_walk($packages, function (&$item) {
163	5	$item = "'".$item."'";
164	5	});
165
166	5	($this->language) ? $language = ", language: '".$this->language."'" : $language = '';
167
168	5	$load = "'".$this->version."', {packages:[".implode(',', $packages).']'.$language.'}';
169
170	5	return "google.charts.load($load);";
171		}
172
173	5	public function startCallback($name)
174		{
175	5	return "google.charts.setOnLoadCallback($name); function $name() {";
176		}
177
178	5	public function endCallback()
179		{
180	5	return '}';
181		}
182		}
183

cmen / CMENGoogleChartsBundle

Pull Request — master (#38)

ChartOutput::endCallback() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like