HighchartsNavigation::jsonSerialize() - Code Metrics - webeweb/highcharts-bundle - Measure and Improve Code Quality continuously with Scrutinizer

HighchartsNavigation::jsonSerialize() A
last analyzed 2021-04-27 16:29 UTC

↳ Parent: HighchartsNavigation

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?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;

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

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

    /**
     * Button options.
     *
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions
     */
    private $buttonOptions;

    /**
     * Menu item hover style.
     *
     * @var array
     * @since 2.0
     */
    private $menuItemHoverStyle = ["background" => "#335cad", "color" => "#ffffff"];

    /**
     * Menu item style.
     *
     * @var array
     * @since 2.0
     */
    private $menuItemStyle = ["padding" => "0.5em 1em", "color" => "#333333", "background" => "none"];

    /**
     * Menu style.
     *
     * @var array
     * @since 2.0
     */
    private $menuStyle = ["border" => "1px solid #999999", "background" => "#ffffff", "padding" => "5px 0"];

    /**
     * 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 button options.
        if (null !== $this->buttonOptions) {
            $this->buttonOptions->clear();
        }

        // Clear the menu item hover style.
        $this->menuItemHoverStyle = null;


        // Clear the menu item style.
        $this->menuItemStyle = null;


        // Clear the menu style.
        $this->menuStyle = null;

    }

    /**
     * Get the button options.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the button options.
     */
    public function getButtonOptions() {
        return $this->buttonOptions;
    }

    /**
     * Get the menu item hover style.
     *
     * @return array Returns the menu item hover style.
     */
    public function getMenuItemHoverStyle() {
        return $this->menuItemHoverStyle;
    }

    /**
     * Get the menu item style.
     *
     * @return array Returns the menu item style.
     */
    public function getMenuItemStyle() {
        return $this->menuItemStyle;
    }

    /**
     * Get the menu style.
     *
     * @return array Returns the menu style.
     */
    public function getMenuStyle() {
        return $this->menuStyle;
    }

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

    /**
     * Create a new button options.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the button options.
     */
    public function newButtonOptions() {
        $this->buttonOptions = new \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions();
        return $this->buttonOptions;
    }

    /**
     * Set the button options.
     *
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions $buttonOptions The button options.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
     */
    public function setButtonOptions(\WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions $buttonOptions = null) {
        $this->buttonOptions = $buttonOptions;
        return $this;
    }

    /**
     * Set the menu item hover style.
     *
     * @param array $menuItemHoverStyle The menu item hover style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
     */
    public function setMenuItemHoverStyle(array $menuItemHoverStyle = null) {
        $this->menuItemHoverStyle = $menuItemHoverStyle;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

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

    /**
     * Set the menu item style.
     *
     * @param array $menuItemStyle The menu item style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
     */
    public function setMenuItemStyle(array $menuItemStyle = null) {
        $this->menuItemStyle = $menuItemStyle;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

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

    /**
     * Set the menu style.
     *
     * @param array $menuStyle The menu style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
     */
    public function setMenuStyle(array $menuStyle = null) {
        $this->menuStyle = $menuStyle;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}
        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 button options.
        if (null !== $this->buttonOptions) {
            ArrayUtility::set($output, "buttonOptions", $this->buttonOptions->toArray(), []);
        }

        // Set the menu item hover style.
        ArrayUtility::set($output, "menuItemHoverStyle", $this->menuItemHoverStyle, [null]);

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

        // Set the menu style.
        ArrayUtility::set($output, "menuStyle", $this->menuStyle, [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;
13
14			use JsonSerializable;
15			use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17			/**
18			* Highcharts navigation.
19			*
20			* @author webeweb <https://github.com/webeweb/>
21			* @package WBW\Bundle\HighchartsBundle\API\Chart
22			* @version 5.0.14
23			* @final
24			*/
25			final class HighchartsNavigation implements JsonSerializable {
26
27			/**
28			* Button options.
29			*
30			* @var \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions
31			*/
32			private $buttonOptions;
33
34			/**
35			* Menu item hover style.
36			*
37			* @var array
38			* @since 2.0
39			*/
40			private $menuItemHoverStyle = ["background" => "#335cad", "color" => "#ffffff"];
41
42			/**
43			* Menu item style.
44			*
45			* @var array
46			* @since 2.0
47			*/
48			private $menuItemStyle = ["padding" => "0.5em 1em", "color" => "#333333", "background" => "none"];
49
50			/**
51			* Menu style.
52			*
53			* @var array
54			* @since 2.0
55			*/
56			private $menuStyle = ["border" => "1px solid #999999", "background" => "#ffffff", "padding" => "5px 0"];
57
58			/**
59			* Constructor.
60			*
61			* @param boolean $ignoreDefaultValues Ignore the default values.
62			*/
63			public function __construct($ignoreDefaultValues = true) {
64			if (true === $ignoreDefaultValues) {
65			$this->clear();
66			}
67			}
68
69			/**
70			* Clear.
71			*
72			* @return void
73			*/
74			public function clear() {
75
76			// Clear the button options.
77			if (null !== $this->buttonOptions) {
78			$this->buttonOptions->clear();
79			}
80
81			// Clear the menu item hover style.
82			$this->menuItemHoverStyle = 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 `$menuItemHoverStyle`. 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...
83
84			// Clear the menu item style.
85			$this->menuItemStyle = 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 `$menuItemStyle`. 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...
86
87			// Clear the menu style.
88			$this->menuStyle = 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 `$menuStyle`. 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...
89			}
90
91			/**
92			* Get the button options.
93			*
94			* @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the button options.
95			*/
96			public function getButtonOptions() {
97			return $this->buttonOptions;
98			}
99
100			/**
101			* Get the menu item hover style.
102			*
103			* @return array Returns the menu item hover style.
104			*/
105			public function getMenuItemHoverStyle() {
106			return $this->menuItemHoverStyle;
107			}
108
109			/**
110			* Get the menu item style.
111			*
112			* @return array Returns the menu item style.
113			*/
114			public function getMenuItemStyle() {
115			return $this->menuItemStyle;
116			}
117
118			/**
119			* Get the menu style.
120			*
121			* @return array Returns the menu style.
122			*/
123			public function getMenuStyle() {
124			return $this->menuStyle;
125			}
126
127			/**
128			* Serialize this instance.
129			*
130			* @return array Returns an array representing this instance.
131			*/
132			public function jsonSerialize() {
133			return $this->toArray();
134			}
135
136			/**
137			* Create a new button options.
138			*
139			* @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the button options.
140			*/
141			public function newButtonOptions() {
142			$this->buttonOptions = new \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions();
143			return $this->buttonOptions;
144			}
145
146			/**
147			* Set the button options.
148			*
149			* @param \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions $buttonOptions The button options.
150			* @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
151			*/
152			public function setButtonOptions(\WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions $buttonOptions = null) {
153			$this->buttonOptions = $buttonOptions;
154			return $this;
155			}
156
157			/**
158			* Set the menu item hover style.
159			*
160			* @param array $menuItemHoverStyle The menu item hover style.
161			* @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
162			*/
163			public function setMenuItemHoverStyle(array $menuItemHoverStyle = null) {
164			$this->menuItemHoverStyle = $menuItemHoverStyle;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `$menuItemHoverStyle` can be `null`. However, the property `$menuItemHoverStyle` 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...
165			return $this;
166			}
167
168			/**
169			* Set the menu item style.
170			*
171			* @param array $menuItemStyle The menu item style.
172			* @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
173			*/
174			public function setMenuItemStyle(array $menuItemStyle = null) {
175			$this->menuItemStyle = $menuItemStyle;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `$menuItemStyle` can be `null`. However, the property `$menuItemStyle` 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...
176			return $this;
177			}
178
179			/**
180			* Set the menu style.
181			*
182			* @param array $menuStyle The menu style.
183			* @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNavigation Returns the highcharts navigation.
184			*/
185			public function setMenuStyle(array $menuStyle = null) {
186			$this->menuStyle = $menuStyle;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `$menuStyle` can be `null`. However, the property `$menuStyle` 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...
187			return $this;
188			}
189
190			/**
191			* Convert into an array representing this instance.
192			*
193			* @return array Returns an array representing this instance.
194			*/
195			public function toArray() {
196
197			// Initialize the output.
198			$output = [];
199
200			// Set the button options.
201			if (null !== $this->buttonOptions) {
202			ArrayUtility::set($output, "buttonOptions", $this->buttonOptions->toArray(), []);
203			}
204
205			// Set the menu item hover style.
206			ArrayUtility::set($output, "menuItemHoverStyle", $this->menuItemHoverStyle, [null]);
207
208			// Set the menu item style.
209			ArrayUtility::set($output, "menuItemStyle", $this->menuItemStyle, [null]);
210
211			// Set the menu style.
212			ArrayUtility::set($output, "menuStyle", $this->menuStyle, [null]);
213
214			// Return the output.
215			return $output;
216			}
217
218			}
219

webeweb / highcharts-bundle

HighchartsNavigation::jsonSerialize() A last analyzed 2021-04-27 16:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HighchartsNavigation::jsonSerialize() A
last analyzed 2021-04-27 16:29 UTC