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

HighchartsStackLabels::setFormatter() A
last analyzed 2021-04-27 16:29 UTC

↳ Parent: HighchartsStackLabels

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

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

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

    /**
     * Align.
     *
     * @var string
     * @since 2.1.5
     */
    private $align;

    /**
     * Enabled.
     *
     * @var boolean
     * @since 2.1.5
     */
    private $enabled = false;

    /**
     * Format.
     *
     * @var string
     * @since 3.0.2
     */
    private $format = "{total}";

    /**
     * Formatter.
     *
     * @var string
     * @since 2.1.5
     */
    private $formatter;

    /**
     * Rotation.
     *
     * @var integer
     * @since 2.1.5
     */
    private $rotation = 0;

    /**
     * Style.
     *
     * @var array
     * @since 2.1.5
     */
    private $style = ["color" => "#000000", "fontSize" => "11px", "fontWeight" => "bold", "textShadow" => "1px 1px contrast, -1px -1px contrast, -1px 1px contrast, 1px -1px contrast"];

    /**
     * Text align.
     *
     * @var string
     * @since 2.1.5
     */
    private $textAlign;

    /**
     * Use HTML.
     *
     * @var boolean
     * @since 3.0
     */
    private $useHTML = false;

    /**
     * Vertical align.
     *
     * @var string
     * @since 2.1.5
     */
    private $verticalAlign;

    /**
     * X.
     *
     * @var integer
     * @since 2.1.5
     */
    private $x;

    /**
     * Y.
     *
     * @var integer
     * @since 2.1.5
     */
    private $y;

    /**
     * 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 align.
        $this->align = null;

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

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

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

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

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


        // Clear the text align.
        $this->textAlign = null;

        // Clear the use HTML.
        $this->useHTML = null;

        // Clear the vertical align.
        $this->verticalAlign = null;

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

        // Clear the y.
        $this->y = null;
    }

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

    /**
     * Get the enabled.
     *
     * @return boolean Returns the enabled.
     */
    public function getEnabled() {
        return $this->enabled;
    }

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

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

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

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

    /**
     * Get the text align.
     *
     * @return string Returns the text align.
     */
    public function getTextAlign() {
        return $this->textAlign;
    }

    /**
     * Get the use HTML.
     *
     * @return boolean Returns the use HTML.
     */
    public function getUseHTML() {
        return $this->useHTML;
    }

    /**
     * Get the vertical align.
     *
     * @return string Returns the vertical align.
     */
    public function getVerticalAlign() {
        return $this->verticalAlign;
    }

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

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

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

    /**
     * Set the align.
     *
     * @param string $align The align.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setAlign($align) {
        switch ($align) {
            case "center":
            case "left":
            case "right":
            $this->align = $align;
            break;
        }
        return $this;
    }

    /**
     * Set the enabled.
     *
     * @param boolean $enabled The enabled.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setEnabled($enabled) {
        $this->enabled = $enabled;
        return $this;
    }

    /**
     * Set the format.
     *
     * @param string $format The format.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setFormat($format) {
        $this->format = $format;
        return $this;
    }

    /**
     * Set the formatter.
     *
     * @param string $formatter The formatter.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setFormatter($formatter) {
        $this->formatter = $formatter;
        return $this;
    }

    /**
     * Set the rotation.
     *
     * @param integer $rotation The rotation.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setRotation($rotation) {
        $this->rotation = $rotation;
        return $this;
    }

    /**
     * Set the style.
     *
     * @param array $style The style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setStyle(array $style = null) {
        $this->style = $style;
function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

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

    /**
     * Set the text align.
     *
     * @param string $textAlign The text align.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setTextAlign($textAlign) {
        switch ($textAlign) {
            case "center":
            case "left":
            case "right":
            $this->textAlign = $textAlign;
            break;
        }
        return $this;
    }

    /**
     * Set the use HTML.
     *
     * @param boolean $useHTML The use HTML.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setUseHTML($useHTML) {
        $this->useHTML = $useHTML;
        return $this;
    }

    /**
     * Set the vertical align.
     *
     * @param string $verticalAlign The vertical align.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setVerticalAlign($verticalAlign) {
        switch ($verticalAlign) {
            case "bottom":
            case "middle":
            case "top":
            $this->verticalAlign = $verticalAlign;
            break;
        }
        return $this;
    }

    /**
     * Set the x.
     *
     * @param integer $x The x.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setX($x) {
        $this->x = $x;
        return $this;
    }

    /**
     * Set the y.
     *
     * @param integer $y The y.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
     */
    public function setY($y) {
        $this->y = $y;
        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 align.
        ArrayUtility::set($output, "align", $this->align, [null]);

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

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

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

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

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

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

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

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

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

        // Set the y.
        ArrayUtility::set($output, "y", $this->y, [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\YAxis;
13
14			use JsonSerializable;
15			use WBW\Library\Core\Utility\Argument\ArrayUtility;
16
17			/**
18			* Highcharts stack labels.
19			*
20			* @author webeweb <https://github.com/webeweb/>
21			* @package WBW\Bundle\HighchartsBundle\API\Chart\YAxis
22			* @version 5.0.14
23			* @final
24			*/
25			final class HighchartsStackLabels implements JsonSerializable {
26
27			/**
28			* Align.
29			*
30			* @var string
31			* @since 2.1.5
32			*/
33			private $align;
34
35			/**
36			* Enabled.
37			*
38			* @var boolean
39			* @since 2.1.5
40			*/
41			private $enabled = false;
42
43			/**
44			* Format.
45			*
46			* @var string
47			* @since 3.0.2
48			*/
49			private $format = "{total}";
50
51			/**
52			* Formatter.
53			*
54			* @var string
55			* @since 2.1.5
56			*/
57			private $formatter;
58
59			/**
60			* Rotation.
61			*
62			* @var integer
63			* @since 2.1.5
64			*/
65			private $rotation = 0;
66
67			/**
68			* Style.
69			*
70			* @var array
71			* @since 2.1.5
72			*/
73			private $style = ["color" => "#000000", "fontSize" => "11px", "fontWeight" => "bold", "textShadow" => "1px 1px contrast, -1px -1px contrast, -1px 1px contrast, 1px -1px contrast"];
74
75			/**
76			* Text align.
77			*
78			* @var string
79			* @since 2.1.5
80			*/
81			private $textAlign;
82
83			/**
84			* Use HTML.
85			*
86			* @var boolean
87			* @since 3.0
88			*/
89			private $useHTML = false;
90
91			/**
92			* Vertical align.
93			*
94			* @var string
95			* @since 2.1.5
96			*/
97			private $verticalAlign;
98
99			/**
100			* X.
101			*
102			* @var integer
103			* @since 2.1.5
104			*/
105			private $x;
106
107			/**
108			* Y.
109			*
110			* @var integer
111			* @since 2.1.5
112			*/
113			private $y;
114
115			/**
116			* Constructor.
117			*
118			* @param boolean $ignoreDefaultValues Ignore the default values.
119			*/
120			public function __construct($ignoreDefaultValues = true) {
121			if (true === $ignoreDefaultValues) {
122			$this->clear();
123			}
124			}
125
126			/**
127			* Clear.
128			*
129			* @return void
130			*/
131			public function clear() {
132
133			// Clear the align.
134			$this->align = null;
135
136			// Clear the enabled.
137			$this->enabled = null;
138
139			// Clear the format.
140			$this->format = null;
141
142			// Clear the formatter.
143			$this->formatter = null;
144
145			// Clear the rotation.
146			$this->rotation = null;
147
148			// Clear the style.
149			$this->style = 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 `$style`. 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...
150
151			// Clear the text align.
152			$this->textAlign = null;
153
154			// Clear the use HTML.
155			$this->useHTML = null;
156
157			// Clear the vertical align.
158			$this->verticalAlign = null;
159
160			// Clear the x.
161			$this->x = null;
162
163			// Clear the y.
164			$this->y = null;
165			}
166
167			/**
168			* Get the align.
169			*
170			* @return string Returns the align.
171			*/
172			public function getAlign() {
173			return $this->align;
174			}
175
176			/**
177			* Get the enabled.
178			*
179			* @return boolean Returns the enabled.
180			*/
181			public function getEnabled() {
182			return $this->enabled;
183			}
184
185			/**
186			* Get the format.
187			*
188			* @return string Returns the format.
189			*/
190			public function getFormat() {
191			return $this->format;
192			}
193
194			/**
195			* Get the formatter.
196			*
197			* @return string Returns the formatter.
198			*/
199			public function getFormatter() {
200			return $this->formatter;
201			}
202
203			/**
204			* Get the rotation.
205			*
206			* @return integer Returns the rotation.
207			*/
208			public function getRotation() {
209			return $this->rotation;
210			}
211
212			/**
213			* Get the style.
214			*
215			* @return array Returns the style.
216			*/
217			public function getStyle() {
218			return $this->style;
219			}
220
221			/**
222			* Get the text align.
223			*
224			* @return string Returns the text align.
225			*/
226			public function getTextAlign() {
227			return $this->textAlign;
228			}
229
230			/**
231			* Get the use HTML.
232			*
233			* @return boolean Returns the use HTML.
234			*/
235			public function getUseHTML() {
236			return $this->useHTML;
237			}
238
239			/**
240			* Get the vertical align.
241			*
242			* @return string Returns the vertical align.
243			*/
244			public function getVerticalAlign() {
245			return $this->verticalAlign;
246			}
247
248			/**
249			* Get the x.
250			*
251			* @return integer Returns the x.
252			*/
253			public function getX() {
254			return $this->x;
255			}
256
257			/**
258			* Get the y.
259			*
260			* @return integer Returns the y.
261			*/
262			public function getY() {
263			return $this->y;
264			}
265
266			/**
267			* Serialize this instance.
268			*
269			* @return array Returns an array representing this instance.
270			*/
271			public function jsonSerialize() {
272			return $this->toArray();
273			}
274
275			/**
276			* Set the align.
277			*
278			* @param string $align The align.
279			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
280			*/
281			public function setAlign($align) {
282			switch ($align) {
283			case "center":
284			case "left":
285			case "right":
286			$this->align = $align;
287			break;
288			}
289			return $this;
290			}
291
292			/**
293			* Set the enabled.
294			*
295			* @param boolean $enabled The enabled.
296			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
297			*/
298			public function setEnabled($enabled) {
299			$this->enabled = $enabled;
300			return $this;
301			}
302
303			/**
304			* Set the format.
305			*
306			* @param string $format The format.
307			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
308			*/
309			public function setFormat($format) {
310			$this->format = $format;
311			return $this;
312			}
313
314			/**
315			* Set the formatter.
316			*
317			* @param string $formatter The formatter.
318			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
319			*/
320			public function setFormatter($formatter) {
321			$this->formatter = $formatter;
322			return $this;
323			}
324
325			/**
326			* Set the rotation.
327			*
328			* @param integer $rotation The rotation.
329			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
330			*/
331			public function setRotation($rotation) {
332			$this->rotation = $rotation;
333			return $this;
334			}
335
336			/**
337			* Set the style.
338			*
339			* @param array $style The style.
340			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
341			*/
342			public function setStyle(array $style = null) {
343			$this->style = $style;
			0 ignored issues – show Documentation Bug introduced 2021-02-02 15:21 UTC by Report Bug Copy Issue Report It seems like `$style` can be `null`. However, the property `$style` 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...
344			return $this;
345			}
346
347			/**
348			* Set the text align.
349			*
350			* @param string $textAlign The text align.
351			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
352			*/
353			public function setTextAlign($textAlign) {
354			switch ($textAlign) {
355			case "center":
356			case "left":
357			case "right":
358			$this->textAlign = $textAlign;
359			break;
360			}
361			return $this;
362			}
363
364			/**
365			* Set the use HTML.
366			*
367			* @param boolean $useHTML The use HTML.
368			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
369			*/
370			public function setUseHTML($useHTML) {
371			$this->useHTML = $useHTML;
372			return $this;
373			}
374
375			/**
376			* Set the vertical align.
377			*
378			* @param string $verticalAlign The vertical align.
379			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
380			*/
381			public function setVerticalAlign($verticalAlign) {
382			switch ($verticalAlign) {
383			case "bottom":
384			case "middle":
385			case "top":
386			$this->verticalAlign = $verticalAlign;
387			break;
388			}
389			return $this;
390			}
391
392			/**
393			* Set the x.
394			*
395			* @param integer $x The x.
396			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
397			*/
398			public function setX($x) {
399			$this->x = $x;
400			return $this;
401			}
402
403			/**
404			* Set the y.
405			*
406			* @param integer $y The y.
407			* @return \WBW\Bundle\HighchartsBundle\API\Chart\YAxis\HighchartsStackLabels Returns the highcharts stack labels.
408			*/
409			public function setY($y) {
410			$this->y = $y;
411			return $this;
412			}
413
414			/**
415			* Convert into an array representing this instance.
416			*
417			* @return array Returns an array representing this instance.
418			*/
419			public function toArray() {
420
421			// Initialize the output.
422			$output = [];
423
424			// Set the align.
425			ArrayUtility::set($output, "align", $this->align, [null]);
426
427			// Set the enabled.
428			ArrayUtility::set($output, "enabled", $this->enabled, [null]);
429
430			// Set the format.
431			ArrayUtility::set($output, "format", $this->format, [null]);
432
433			// Set the formatter.
434			ArrayUtility::set($output, "formatter", $this->formatter, [null]);
435
436			// Set the rotation.
437			ArrayUtility::set($output, "rotation", $this->rotation, [null]);
438
439			// Set the style.
440			ArrayUtility::set($output, "style", $this->style, [null]);
441
442			// Set the text align.
443			ArrayUtility::set($output, "textAlign", $this->textAlign, [null]);
444
445			// Set the use HTML.
446			ArrayUtility::set($output, "useHTML", $this->useHTML, [null]);
447
448			// Set the vertical align.
449			ArrayUtility::set($output, "verticalAlign", $this->verticalAlign, [null]);
450
451			// Set the x.
452			ArrayUtility::set($output, "x", $this->x, [null]);
453
454			// Set the y.
455			ArrayUtility::set($output, "y", $this->y, [null]);
456
457			// Return the output.
458			return $output;
459			}
460
461			}
462

webeweb / highcharts-bundle

HighchartsStackLabels::setFormatter() A last analyzed 2021-04-27 16:29 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HighchartsStackLabels::setFormatter() A
last analyzed 2021-04-27 16:29 UTC