HighchartsPlotBands - Code Metrics - webeweb/highcharts-bundle - Measure and Improve Code Quality continuously with Scrutinizer

HighchartsPlotBands A
last analyzed 2021-04-27 16:29 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	392
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
wmc	28
lcom	1
cbo	2
dl	0
loc	392
rs	10
c	0
b	0
f	0

25 Methods

Rating	Name	Size	Complexity
A	__construct()	5	2
A	clear()	34	2
A	getBorderColor()	3	1
A	getBorderWidth()	3	1
A	getClassName()	3	1
A	getColor()	3	1
A	getEvents()	3	1
A	getFrom()	3	1
A	getId()	3	1
A	getLabel()	3	1
A	getTo()	3	1
A	getZIndex()	3	1
A	jsonSerialize()	3	1
A	newLabel()	4	1
A	setBorderColor()	4	1
A	setBorderWidth()	4	1
A	setClassName()	4	1
A	setColor()	4	1
A	setEvents()	4	1
A	setFrom()	4	1
A	setId()	4	1
A	setLabel()	4	1
A	setTo()	4	1
A	setZIndex()	4	1
A	toArray()	40	2

<?php

/**
 * This file is part of the highcharts-bundle package.
 *
 * (c) 2017 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\HighchartsBundle\API\Chart\ZAxis;

use JsonSerializable;
use WBW\Library\Core\Utility\Argument\ArrayUtility;

/**
 * Highcharts plot bands.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\HighchartsBundle\API\Chart\ZAxis
 * @version 5.0.14
 * @final
 */
final class HighchartsPlotBands implements JsonSerializable {

    /**
     * Border color.
     *
     * @var string
     */
    private $borderColor;

    /**
     * Border width.
     *
     * @var integer
     */
    private $borderWidth = 0;

    /**
     * Class name.
     *
     * @var string
     * @since 5.0.0
     */
    private $className;

    /**
     * Color.
     *
     * @var string
     */
    private $color;

    /**
     * Events.
     *
     * @var array
     * @since 1.2
     */
    private $events;

    /**
     * From.
     *
     * @var integer
     */
    private $from;

    /**
     * Id.
     *
     * @var string
     */
    private $id;

    /**
     * Label.
     *
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel
     */
    private $label;

    /**
     * To.
     *
     * @var integer
     */
    private $to;

    /**
     * Z index.
     *
     * @var integer
     * @since 1.2
     */
    private $zIndex;

    /**
     * Constructor.
     *
     * @param boolean $ignoreDefaultValues Ignore the default values.
     */
    public function __construct($ignoreDefaultValues = true) {
        if (true === $ignoreDefaultValues) {
            $this->clear();
        }
    }

    /**
     * Clear.
     *
     * @return void
     */
    public function clear() {

        // Clear the border color.
        $this->borderColor = null;

        // Clear the border width.
        $this->borderWidth = null;

        // Clear the class name.
        $this->className = null;

        // Clear the color.
        $this->color = null;

        // Clear the events.
        $this->events = null;


        // Clear the from.
        $this->from = null;

        // Clear the id.
        $this->id = null;

        // Clear the label.
        if (null !== $this->label) {
            $this->label->clear();
        }

        // Clear the to.
        $this->to = null;

        // Clear the z index.
        $this->zIndex = null;
    }

    /**
     * Get the border color.
     *
     * @return string Returns the border color.
     */
    public function getBorderColor() {
        return $this->borderColor;
    }

    /**
     * Get the border width.
     *
     * @return integer Returns the border width.
     */
    public function getBorderWidth() {
        return $this->borderWidth;
    }

    /**
     * Get the class name.
     *
     * @return string Returns the class name.
     */
    public function getClassName() {
        return $this->className;
    }

    /**
     * Get the color.
     *
     * @return string Returns the color.
     */
    public function getColor() {
        return $this->color;
    }

    /**
     * Get the events.
     *
     * @return array Returns the events.
     */
    public function getEvents() {
        return $this->events;
    }

    /**
     * Get the from.
     *
     * @return integer Returns the from.
     */
    public function getFrom() {
        return $this->from;
    }

    /**
     * Get the id.
     *
     * @return string Returns the id.
     */
    public function getId() {
        return $this->id;
    }

    /**
     * Get the label.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel Returns the label.
     */
    public function getLabel() {
        return $this->label;
    }

    /**
     * Get the to.
     *
     * @return integer Returns the to.
     */
    public function getTo() {
        return $this->to;
    }

    /**
     * Get the z index.
     *
     * @return integer Returns the z index.
     */
    public function getZIndex() {
        return $this->zIndex;
    }

    /**
     * Serialize this instance.
     *
     * @return array Returns an array representing this instance.
     */
    public function jsonSerialize() {
        return $this->toArray();
    }

    /**
     * Create a new label.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel Returns the label.
     */
    public function newLabel() {
        $this->label = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel();
        return $this->label;
    }

    /**
     * Set the border color.
     *
     * @param string $borderColor The border color.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setBorderColor($borderColor) {
        $this->borderColor = $borderColor;
        return $this;
    }

    /**
     * Set the border width.
     *
     * @param integer $borderWidth The border width.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setBorderWidth($borderWidth) {
        $this->borderWidth = $borderWidth;
        return $this;
    }

    /**
     * Set the class name.
     *
     * @param string $className The class name.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setClassName($className) {
        $this->className = $className;
        return $this;
    }

    /**
     * Set the color.
     *
     * @param string $color The color.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setColor($color) {
        $this->color = $color;
        return $this;
    }

    /**
     * Set the events.
     *
     * @param array $events The events.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setEvents(array $events = null) {
        $this->events = $events;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}
        return $this;
    }

    /**
     * Set the from.
     *
     * @param integer $from The from.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setFrom($from) {
        $this->from = $from;
        return $this;
    }

    /**
     * Set the id.
     *
     * @param string $id The id.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setId($id) {
        $this->id = $id;
        return $this;
    }

    /**
     * Set the label.
     *
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel $label The label.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setLabel(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel $label = null) {
        $this->label = $label;
        return $this;
    }

    /**
     * Set the to.
     *
     * @param integer $to The to.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setTo($to) {
        $this->to = $to;
        return $this;
    }

    /**
     * Set the z index.
     *
     * @param integer $zIndex The z index.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
     */
    public function setZIndex($zIndex) {
        $this->zIndex = $zIndex;
        return $this;
    }

    /**
     * Convert into an array representing this instance.
     *
     * @return array Returns an array representing this instance.
     */
    public function toArray() {

        // Initialize the output.
        $output = [];

        // Set the border color.
        ArrayUtility::set($output, "borderColor", $this->borderColor, [null]);

        // Set the border width.
        ArrayUtility::set($output, "borderWidth", $this->borderWidth, [null]);

        // Set the class name.
        ArrayUtility::set($output, "className", $this->className, [null]);

        // Set the color.
        ArrayUtility::set($output, "color", $this->color, [null]);

        // Set the events.
        ArrayUtility::set($output, "events", $this->events, [null]);

        // Set the from.
        ArrayUtility::set($output, "from", $this->from, [null]);

        // Set the id.
        ArrayUtility::set($output, "id", $this->id, [null]);

        // Set the label.
        if (null !== $this->label) {
            ArrayUtility::set($output, "label", $this->label->toArray(), []);
        }

        // Set the to.
        ArrayUtility::set($output, "to", $this->to, [null]);

        // Set the z index.
        ArrayUtility::set($output, "zIndex", $this->zIndex, [null]);

        // Return the output.
        return $output;
    }

}


1			<?php
2
3			/**
4			* This file is part of the highcharts-bundle package.
5			*
6			* (c) 2017 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\HighchartsBundle\API\Chart\ZAxis;
13
14			use JsonSerializable;
15			use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17			/**
18			* Highcharts plot bands.
19			*
20			* @author webeweb <https://github.com/webeweb/>
21			* @package WBW\Bundle\HighchartsBundle\API\Chart\ZAxis
22			* @version 5.0.14
23			* @final
24			*/
25			final class HighchartsPlotBands implements JsonSerializable {
26
27			/**
28			* Border color.
29			*
30			* @var string
31			*/
32			private $borderColor;
33
34			/**
35			* Border width.
36			*
37			* @var integer
38			*/
39			private $borderWidth = 0;
40
41			/**
42			* Class name.
43			*
44			* @var string
45			* @since 5.0.0
46			*/
47			private $className;
48
49			/**
50			* Color.
51			*
52			* @var string
53			*/
54			private $color;
55
56			/**
57			* Events.
58			*
59			* @var array
60			* @since 1.2
61			*/
62			private $events;
63
64			/**
65			* From.
66			*
67			* @var integer
68			*/
69			private $from;
70
71			/**
72			* Id.
73			*
74			* @var string
75			*/
76			private $id;
77
78			/**
79			* Label.
80			*
81			* @var \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel
82			*/
83			private $label;
84
85			/**
86			* To.
87			*
88			* @var integer
89			*/
90			private $to;
91
92			/**
93			* Z index.
94			*
95			* @var integer
96			* @since 1.2
97			*/
98			private $zIndex;
99
100			/**
101			* Constructor.
102			*
103			* @param boolean $ignoreDefaultValues Ignore the default values.
104			*/
105			public function __construct($ignoreDefaultValues = true) {
106			if (true === $ignoreDefaultValues) {
107			$this->clear();
108			}
109			}
110
111			/**
112			* Clear.
113			*
114			* @return void
115			*/
116			public function clear() {
117
118			// Clear the border color.
119			$this->borderColor = null;
120
121			// Clear the border width.
122			$this->borderWidth = null;
123
124			// Clear the class name.
125			$this->className = null;
126
127			// Clear the color.
128			$this->color = null;
129
130			// Clear the events.
131			$this->events = null;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$events`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
132
133			// Clear the from.
134			$this->from = null;
135
136			// Clear the id.
137			$this->id = null;
138
139			// Clear the label.
140			if (null !== $this->label) {
141			$this->label->clear();
142			}
143
144			// Clear the to.
145			$this->to = null;
146
147			// Clear the z index.
148			$this->zIndex = null;
149			}
150
151			/**
152			* Get the border color.
153			*
154			* @return string Returns the border color.
155			*/
156			public function getBorderColor() {
157			return $this->borderColor;
158			}
159
160			/**
161			* Get the border width.
162			*
163			* @return integer Returns the border width.
164			*/
165			public function getBorderWidth() {
166			return $this->borderWidth;
167			}
168
169			/**
170			* Get the class name.
171			*
172			* @return string Returns the class name.
173			*/
174			public function getClassName() {
175			return $this->className;
176			}
177
178			/**
179			* Get the color.
180			*
181			* @return string Returns the color.
182			*/
183			public function getColor() {
184			return $this->color;
185			}
186
187			/**
188			* Get the events.
189			*
190			* @return array Returns the events.
191			*/
192			public function getEvents() {
193			return $this->events;
194			}
195
196			/**
197			* Get the from.
198			*
199			* @return integer Returns the from.
200			*/
201			public function getFrom() {
202			return $this->from;
203			}
204
205			/**
206			* Get the id.
207			*
208			* @return string Returns the id.
209			*/
210			public function getId() {
211			return $this->id;
212			}
213
214			/**
215			* Get the label.
216			*
217			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel Returns the label.
218			*/
219			public function getLabel() {
220			return $this->label;
221			}
222
223			/**
224			* Get the to.
225			*
226			* @return integer Returns the to.
227			*/
228			public function getTo() {
229			return $this->to;
230			}
231
232			/**
233			* Get the z index.
234			*
235			* @return integer Returns the z index.
236			*/
237			public function getZIndex() {
238			return $this->zIndex;
239			}
240
241			/**
242			* Serialize this instance.
243			*
244			* @return array Returns an array representing this instance.
245			*/
246			public function jsonSerialize() {
247			return $this->toArray();
248			}
249
250			/**
251			* Create a new label.
252			*
253			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel Returns the label.
254			*/
255			public function newLabel() {
256			$this->label = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel();
257			return $this->label;
258			}
259
260			/**
261			* Set the border color.
262			*
263			* @param string $borderColor The border color.
264			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
265			*/
266			public function setBorderColor($borderColor) {
267			$this->borderColor = $borderColor;
268			return $this;
269			}
270
271			/**
272			* Set the border width.
273			*
274			* @param integer $borderWidth The border width.
275			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
276			*/
277			public function setBorderWidth($borderWidth) {
278			$this->borderWidth = $borderWidth;
279			return $this;
280			}
281
282			/**
283			* Set the class name.
284			*
285			* @param string $className The class name.
286			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
287			*/
288			public function setClassName($className) {
289			$this->className = $className;
290			return $this;
291			}
292
293			/**
294			* Set the color.
295			*
296			* @param string $color The color.
297			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
298			*/
299			public function setColor($color) {
300			$this->color = $color;
301			return $this;
302			}
303
304			/**
305			* Set the events.
306			*
307			* @param array $events The events.
308			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
309			*/
310			public function setEvents(array $events = null) {
311			$this->events = $events;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `$events` can be `null`. However, the property `$events` is declared as `array`. Maybe change the type of the property to `array\|null` or add a type check? Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property. To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter. function aContainsB(array $needle = null, array $haystack) { if (!$needle) { return false; } return array_intersect($haystack, $needle) == $haystack; } The function can be called with either null or an array for the parameter `$needle` but will only accept an array as `$haystack`. Loading history...
312			return $this;
313			}
314
315			/**
316			* Set the from.
317			*
318			* @param integer $from The from.
319			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
320			*/
321			public function setFrom($from) {
322			$this->from = $from;
323			return $this;
324			}
325
326			/**
327			* Set the id.
328			*
329			* @param string $id The id.
330			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
331			*/
332			public function setId($id) {
333			$this->id = $id;
334			return $this;
335			}
336
337			/**
338			* Set the label.
339			*
340			* @param \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel $label The label.
341			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
342			*/
343			public function setLabel(\WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotBands\HighchartsLabel $label = null) {
344			$this->label = $label;
345			return $this;
346			}
347
348			/**
349			* Set the to.
350			*
351			* @param integer $to The to.
352			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
353			*/
354			public function setTo($to) {
355			$this->to = $to;
356			return $this;
357			}
358
359			/**
360			* Set the z index.
361			*
362			* @param integer $zIndex The z index.
363			* @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotBands Returns the highcharts plot bands.
364			*/
365			public function setZIndex($zIndex) {
366			$this->zIndex = $zIndex;
367			return $this;
368			}
369
370			/**
371			* Convert into an array representing this instance.
372			*
373			* @return array Returns an array representing this instance.
374			*/
375			public function toArray() {
376
377			// Initialize the output.
378			$output = [];
379
380			// Set the border color.
381			ArrayUtility::set($output, "borderColor", $this->borderColor, [null]);
382
383			// Set the border width.
384			ArrayUtility::set($output, "borderWidth", $this->borderWidth, [null]);
385
386			// Set the class name.
387			ArrayUtility::set($output, "className", $this->className, [null]);
388
389			// Set the color.
390			ArrayUtility::set($output, "color", $this->color, [null]);
391
392			// Set the events.
393			ArrayUtility::set($output, "events", $this->events, [null]);
394
395			// Set the from.
396			ArrayUtility::set($output, "from", $this->from, [null]);
397
398			// Set the id.
399			ArrayUtility::set($output, "id", $this->id, [null]);
400
401			// Set the label.
402			if (null !== $this->label) {
403			ArrayUtility::set($output, "label", $this->label->toArray(), []);
404			}
405
406			// Set the to.
407			ArrayUtility::set($output, "to", $this->to, [null]);
408
409			// Set the z index.
410			ArrayUtility::set($output, "zIndex", $this->zIndex, [null]);
411
412			// Return the output.
413			return $output;
414			}
415
416			}
417

webeweb / highcharts-bundle

HighchartsPlotBands A last analyzed 2021-04-27 16:29 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

25 Methods

Duplication Side-by-Side

Filter issues like

HighchartsPlotBands A
last analyzed 2021-04-27 16:29 UTC