WBW\Bundle\HighchartsBundle\API\Chart\Drilldown\HighchartsDrillUpButton

Complexity

Total Complexity

11

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	clear()	0	11	1
A	getPosition()	0	3	1
A	getRelativeTo()	0	3	1
A	getTheme()	0	3	1
A	jsonSerialize()	0	3	1
A	setPosition()	0	4	1
A	setRelativeTo()	0	4	1
A	setTheme()	0	4	1
A	toArray()	0	17	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\Drilldown;

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

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

    /**
     * Position.
     *
     * @var array
     * @since 3.0.8
     */
    private $position;

    /**
     * Relative to.
     *
     * @var string
     * @since 3.0.8
     */
    private $relativeTo = "plotBox";

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

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

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

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

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

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

    }

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

    /**
     * Get the relative to.
     *
     * @return string Returns the relative to.
     */
    public function getRelativeTo() {
        return $this->relativeTo;
    }

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

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

    /**
     * Set the position.
     *
     * @param array $position The position.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Drilldown\HighchartsDrillUpButton Returns the highcharts drill up button.
     */
    public function setPosition(array $position = null) {
        $this->position = $position;

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

        return $this;
    }

    /**
     * Set the relative to.
     *
     * @param string $relativeTo The relative to.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Drilldown\HighchartsDrillUpButton Returns the highcharts drill up button.
     */
    public function setRelativeTo($relativeTo) {
        $this->relativeTo = $relativeTo;
        return $this;
    }

    /**
     * Set the theme.
     *
     * @param array $theme The theme.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Drilldown\HighchartsDrillUpButton Returns the highcharts drill up button.
     */
    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;
    }

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

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

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

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

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

        // Return the output.
        return $output;
    }

}