WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotLines

Complexity

Total Complexity

37

Size/Duplication

Total Lines	374
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	clear()	0	31	2
A	getClassName()	0	3	1
A	getColor()	0	3	1
A	getDashStyle()	0	3	1
A	getEvents()	0	3	1
A	getId()	0	3	1
A	getLabel()	0	3	1
A	getValue()	0	3	1
A	getWidth()	0	3	1
A	getZIndex()	0	3	1
A	jsonSerialize()	0	3	1
A	newLabel()	0	4	1
A	setClassName()	0	4	1
A	setColor()	0	4	1
C	setDashStyle()	0	18	12
A	setEvents()	0	4	1
A	setId()	0	4	1
A	setLabel()	0	4	1
A	setValue()	0	4	1
A	setWidth()	0	4	1
A	setZIndex()	0	4	1
A	toArray()	0	37	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 lines.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\HighchartsBundle\API\Chart\ZAxis
 * @version 5.0.14
 * @final
 */
final class HighchartsPlotLines implements JsonSerializable {

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

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

    /**
     * Dash style.
     *
     * @var string
     * @since 1.2
     */
    private $dashStyle = "Solid";

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

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

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

    /**
     * Value.
     *
     * @var integer
     */
    private $value;

    /**
     * Width.
     *
     * @var integer
     */
    private $width;

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

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

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

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

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

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

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

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

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

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

    /**
     * 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 dash style.
     *
     * @return string Returns the dash style.
     */
    public function getDashStyle() {
        return $this->dashStyle;
    }

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

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

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

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

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

    /**
     * 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\PlotLines\HighchartsLabel Returns the label.
     */
    public function newLabel() {
        $this->label = new \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\PlotLines\HighchartsLabel();
        return $this->label;
    }

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

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

    /**
     * Set the dash style.
     *
     * @param string $dashStyle The dash style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotLines Returns the highcharts plot lines.
     */
    public function setDashStyle($dashStyle) {
        switch ($dashStyle) {
            case "Dash":
            case "DashDot":
            case "Dot":
            case "LongDash":
            case "LongDashDot":
            case "LongDashDotDot":
            case "ShortDash":
            case "ShortDashDot":
            case "ShortDashDotDot":
            case "ShortDot":
            case "Solid":
            $this->dashStyle = $dashStyle;
            break;
        }
        return $this;
    }

    /**
     * Set the events.
     *
     * @param array $events The events.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotLines Returns the highcharts plot lines.
     */
    public function setEvents(array $events = null) {
        $this->events = $events;

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?

        return $this;
    }

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

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

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

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

    /**
     * Set the z index.
     *
     * @param integer $zIndex The z index.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\ZAxis\HighchartsPlotLines Returns the highcharts plot lines.
     */
    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 class name.
        ArrayUtility::set($output, "className", $this->className, [null]);

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

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

        // Set the events.
        ArrayUtility::set($output, "events", $this->events, [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 value.
        ArrayUtility::set($output, "value", $this->value, [null]);

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

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

        // Return the output.
        return $output;
    }

}