WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions

Complexity

Total Complexity

39

Size/Duplication

Total Lines	533
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

32 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	clear()	0	44	1
A	getAlign()	0	3	1
A	getEnabled()	0	3	1
A	getHeight()	0	3	1
A	getSymbolFill()	0	3	1
A	getSymbolSize()	0	3	1
A	getSymbolStroke()	0	3	1
A	getSymbolStrokeWidth()	0	3	1
A	getSymbolX()	0	3	1
A	getSymbolY()	0	3	1
A	getText()	0	3	1
A	getTheme()	0	3	1
A	getVerticalAlign()	0	3	1
A	getWidth()	0	3	1
A	getY()	0	3	1
A	jsonSerialize()	0	3	1
A	setAlign()	0	10	4
A	setEnabled()	0	4	1
A	setHeight()	0	4	1
A	setSymbolFill()	0	4	1
A	setSymbolSize()	0	4	1
A	setSymbolStroke()	0	4	1
A	setSymbolStrokeWidth()	0	4	1
A	setSymbolX()	0	4	1
A	setSymbolY()	0	4	1
A	setText()	0	4	1
A	setTheme()	0	4	1
A	setVerticalAlign()	0	10	4
A	setWidth()	0	4	1
A	setY()	0	4	1
A	toArray()	0	50	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\Navigation;

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

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

    /**
     * Align.
     *
     * @var string
     * @since 2.0
     */
    private $align = "right";

    /**
     * Enabled.
     *
     * @var boolean
     * @since 2.0
     */
    private $enabled = true;

    /**
     * Height.
     *
     * @var integer
     * @since 2.0
     */
    private $height = 20;

    /**
     * Symbol fill.
     *
     * @var string
     * @since 2.0
     */
    private $symbolFill = "#666666";

    /**
     * Symbol size.
     *
     * @var integer
     * @since 2.0
     */
    private $symbolSize = 14;

    /**
     * Symbol stroke.
     *
     * @var string
     * @since 2.0
     */
    private $symbolStroke = "#666666";

    /**
     * Symbol stroke width.
     *
     * @var integer
     * @since 2.0
     */
    private $symbolStrokeWidth = 1;

    /**
     * Symbol x.
     *
     * @var integer
     * @since 2.0
     */
    private $symbolX = 12.5;

    /**
     * Symbol y.
     *
     * @var integer
     * @since 2.0
     */
    private $symbolY = 10.5;

    /**
     * Text.
     *
     * @var string
     * @since 3.0
     */
    private $text;

    /**
     * Theme.
     *
     * @var array
     * @since 3.0
     */
    private $theme;

    /**
     * Vertical align.
     *
     * @var string
     * @since 2.0
     */
    private $verticalAlign = "top";

    /**
     * Width.
     *
     * @var integer
     * @since 2.0
     */
    private $width = 24;

    /**
     * Y.
     *
     * @var integer
     * @since 2.0
     */
    private $y = 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 align.
        $this->align = null;

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

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

        // Clear the symbol fill.
        $this->symbolFill = null;

        // Clear the symbol size.
        $this->symbolSize = null;

        // Clear the symbol stroke.
        $this->symbolStroke = null;

        // Clear the symbol stroke width.
        $this->symbolStrokeWidth = null;

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

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

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

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

It seems like null of type null is incompatible with the declared type array of property $theme.

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

        // Clear the width.
        $this->width = 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 height.
     *
     * @return integer Returns the height.
     */
    public function getHeight() {
        return $this->height;
    }

    /**
     * Get the symbol fill.
     *
     * @return string Returns the symbol fill.
     */
    public function getSymbolFill() {
        return $this->symbolFill;
    }

    /**
     * Get the symbol size.
     *
     * @return integer Returns the symbol size.
     */
    public function getSymbolSize() {
        return $this->symbolSize;
    }

    /**
     * Get the symbol stroke.
     *
     * @return string Returns the symbol stroke.
     */
    public function getSymbolStroke() {
        return $this->symbolStroke;
    }

    /**
     * Get the symbol stroke width.
     *
     * @return integer Returns the symbol stroke width.
     */
    public function getSymbolStrokeWidth() {
        return $this->symbolStrokeWidth;
    }

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

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

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

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

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

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

    /**
     * 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\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    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\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setEnabled($enabled) {
        $this->enabled = $enabled;
        return $this;
    }

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

    /**
     * Set the symbol fill.
     *
     * @param string $symbolFill The symbol fill.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolFill($symbolFill) {
        $this->symbolFill = $symbolFill;
        return $this;
    }

    /**
     * Set the symbol size.
     *
     * @param integer $symbolSize The symbol size.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolSize($symbolSize) {
        $this->symbolSize = $symbolSize;
        return $this;
    }

    /**
     * Set the symbol stroke.
     *
     * @param string $symbolStroke The symbol stroke.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolStroke($symbolStroke) {
        $this->symbolStroke = $symbolStroke;
        return $this;
    }

    /**
     * Set the symbol stroke width.
     *
     * @param integer $symbolStrokeWidth The symbol stroke width.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolStrokeWidth($symbolStrokeWidth) {
        $this->symbolStrokeWidth = $symbolStrokeWidth;
        return $this;
    }

    /**
     * Set the symbol x.
     *
     * @param integer $symbolX The symbol x.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolX($symbolX) {
        $this->symbolX = $symbolX;
        return $this;
    }

    /**
     * Set the symbol y.
     *
     * @param integer $symbolY The symbol y.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    public function setSymbolY($symbolY) {
        $this->symbolY = $symbolY;
        return $this;
    }

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

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

It seems like $theme can be null. However, the property $theme is declared as array. Maybe change the type of the property to array|null or add a type check?

        return $this;
    }

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

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

    /**
     * Set the y.
     *
     * @param integer $y The y.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Navigation\HighchartsButtonOptions Returns the highcharts button options.
     */
    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 height.
        ArrayUtility::set($output, "height", $this->height, [null]);

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

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

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

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

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

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

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

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

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

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

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

        // Return the output.
        return $output;
    }

}