webeweb / highcharts-bundle

API/Chart/HighchartsNoData.php

<?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 no data.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\HighchartsBundle\API\Chart
 * @version 5.0.14
 * @final
 */
final class HighchartsNoData implements JsonSerializable {

    /**
     * Attr.
     *
     * @var array
     * @since 3.0.8
     */
    private $attr;

    /**
     * Position.
     *
     * @var array
     * @since 3.0.8
     */
    private $position = ["x" => 0, "y" => 0, "align" => "center", "verticalAlign" => "middle"];

    /**
     * Style.
     *
     * @var array
     * @since 3.0.8
     */
    private $style = ["fontSize" => "12px", "fontWeight" => "bold", "color" => "#666666"];

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

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

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

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

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

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

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

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

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

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

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

    /**
     * Set the attr.
     *
     * @param array $attr The attr.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNoData Returns the highcharts no data.
     */
    public function setAttr(array $attr = null) {
        $this->attr = $attr;

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

        return $this;
    }

    /**
     * Set the position.
     *
     * @param array $position The position.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNoData Returns the highcharts no data.
     */
    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 style.
     *
     * @param array $style The style.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNoData Returns the highcharts no data.
     */
    public function setStyle(array $style = null) {
        $this->style = $style;

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?

        return $this;
    }

    /**
     * Set the use HTML.
     *
     * @param boolean $useHTML The use HTML.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsNoData Returns the highcharts no data.
     */
    public function setUseHTML($useHTML) {
        $this->useHTML = $useHTML;
        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 attr.
        ArrayUtility::set($output, "attr", $this->attr, [null]);

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

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

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

        // Return the output.
        return $output;
    }

}