WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting

Complexity

Total Complexity

46

Size/Duplication

Total Lines	642
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

39 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
B	clear()	0	55	2
A	getAllowHTML()	0	3	1
A	getButtons()	0	3	1
A	getChartOptions()	0	3	1
A	getEnabled()	0	3	1
A	getError()	0	3	1
A	getFallbackToExportServer()	0	3	1
A	getFilename()	0	3	1
A	getFormAttributes()	0	3	1
A	getLibURL()	0	3	1
A	getMenuItemDefinitions()	0	3	1
A	getPrintMaxWidth()	0	3	1
A	getScale()	0	3	1
A	getSourceHeight()	0	3	1
A	getSourceWidth()	0	3	1
A	getType()	0	3	1
A	getUrl()	0	3	1
A	getWidth()	0	3	1
A	jsonSerialize()	0	3	1
A	newButtons()	0	4	1
A	setAllowHTML()	0	4	1
A	setButtons()	0	4	1
A	setChartOptions()	0	4	1
A	setEnabled()	0	4	1
A	setError()	0	4	1
A	setFallbackToExportServer()	0	4	1
A	setFilename()	0	4	1
A	setFormAttributes()	0	4	1
A	setLibURL()	0	4	1
A	setMenuItemDefinitions()	0	4	1
A	setPrintMaxWidth()	0	4	1
A	setScale()	0	4	1
A	setSourceHeight()	0	4	1
A	setSourceWidth()	0	4	1
A	setType()	0	11	5
A	setUrl()	0	4	1
A	setWidth()	0	4	1
B	toArray()	0	61	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;

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

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

    /**
     * Allow HTML.
     *
     * @var boolean
     * @since 4.1.8
     */
    private $allowHTML = false;

    /**
     * Buttons.
     *
     * @var \WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons
     */
    private $buttons;

    /**
     * Chart options.
     *
     * @var array
     */
    private $chartOptions;

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

    /**
     * Error.
     *
     * @var string
     * @since 5.0.0
     */
    private $error;

    /**
     * Fallback to export server.
     *
     * @var boolean
     * @since 4.1.8
     */
    private $fallbackToExportServer = true;

    /**
     * Filename.
     *
     * @var string
     * @since 2.0
     */
    private $filename = "chart";

    /**
     * Form attributes.
     *
     * @var array
     * @since 3.0.8
     */
    private $formAttributes;

    /**
     * Lib URL.
     *
     * @var string
     * @since 5.0.0
     */
    private $libURL = "https://code.highcharts.com/{version}/lib";

    /**
     * Menu item definitions.
     *
     * @var array
     * @since 5.0.13
     */
    private $menuItemDefinitions;

    /**
     * Print max width.
     *
     * @var integer
     * @since 4.2.5
     */
    private $printMaxWidth = 780;

    /**
     * Scale.
     *
     * @var integer
     * @since 3.0
     */
    private $scale = 2;

    /**
     * Source height.
     *
     * @var integer
     * @since 3.0
     */
    private $sourceHeight;

    /**
     * Source width.
     *
     * @var integer
     * @since 3.0
     */
    private $sourceWidth;

    /**
     * Type.
     *
     * @var string
     * @since 2.0
     */
    private $type = "image/png";

    /**
     * Url.
     *
     * @var string
     * @since 2.0
     */
    private $url = "https://export.highcharts.com";

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

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

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

        // Clear the chart options.
        $this->chartOptions = null;

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

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

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

        // Clear the fallback to export server.
        $this->fallbackToExportServer = null;

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

        // Clear the form attributes.
        $this->formAttributes = null;

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

        // Clear the lib URL.
        $this->libURL = null;

        // Clear the menu item definitions.
        $this->menuItemDefinitions = null;

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

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

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

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

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

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

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

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

    /**
     * Get the allow HTML.
     *
     * @return boolean Returns the allow HTML.
     */
    public function getAllowHTML() {
        return $this->allowHTML;
    }

    /**
     * Get the buttons.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons Returns the buttons.
     */
    public function getButtons() {
        return $this->buttons;
    }

    /**
     * Get the chart options.
     *
     * @return array Returns the chart options.
     */
    public function getChartOptions() {
        return $this->chartOptions;
    }

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

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

    /**
     * Get the fallback to export server.
     *
     * @return boolean Returns the fallback to export server.
     */
    public function getFallbackToExportServer() {
        return $this->fallbackToExportServer;
    }

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

    /**
     * Get the form attributes.
     *
     * @return array Returns the form attributes.
     */
    public function getFormAttributes() {
        return $this->formAttributes;
    }

    /**
     * Get the lib URL.
     *
     * @return string Returns the lib URL.
     */
    public function getLibURL() {
        return $this->libURL;
    }

    /**
     * Get the menu item definitions.
     *
     * @return array Returns the menu item definitions.
     */
    public function getMenuItemDefinitions() {
        return $this->menuItemDefinitions;
    }

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

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

    /**
     * Get the source height.
     *
     * @return integer Returns the source height.
     */
    public function getSourceHeight() {
        return $this->sourceHeight;
    }

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

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

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

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

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

    /**
     * Create a new buttons.
     *
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons Returns the buttons.
     */
    public function newButtons() {
        $this->buttons = new \WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons();
        return $this->buttons;
    }

    /**
     * Set the allow HTML.
     *
     * @param boolean $allowHTML The allow HTML.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setAllowHTML($allowHTML) {
        $this->allowHTML = $allowHTML;
        return $this;
    }

    /**
     * Set the buttons.
     *
     * @param \WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons $buttons The buttons.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setButtons(\WBW\Bundle\HighchartsBundle\API\Chart\Exporting\HighchartsButtons $buttons = null) {
        $this->buttons = $buttons;
        return $this;
    }

    /**
     * Set the chart options.
     *
     * @param array $chartOptions The chart options.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setChartOptions(array $chartOptions = null) {
        $this->chartOptions = $chartOptions;

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

        return $this;
    }

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

    /**
     * Set the error.
     *
     * @param string $error The error.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setError($error) {
        $this->error = $error;
        return $this;
    }

    /**
     * Set the fallback to export server.
     *
     * @param boolean $fallbackToExportServer The fallback to export server.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setFallbackToExportServer($fallbackToExportServer) {
        $this->fallbackToExportServer = $fallbackToExportServer;
        return $this;
    }

    /**
     * Set the filename.
     *
     * @param string $filename The filename.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setFilename($filename) {
        $this->filename = $filename;
        return $this;
    }

    /**
     * Set the form attributes.
     *
     * @param array $formAttributes The form attributes.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setFormAttributes(array $formAttributes = null) {
        $this->formAttributes = $formAttributes;

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

        return $this;
    }

    /**
     * Set the lib URL.
     *
     * @param string $libURL The lib URL.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setLibURL($libURL) {
        $this->libURL = $libURL;
        return $this;
    }

    /**
     * Set the menu item definitions.
     *
     * @param array $menuItemDefinitions The menu item definitions.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setMenuItemDefinitions(array $menuItemDefinitions = null) {
        $this->menuItemDefinitions = $menuItemDefinitions;

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

        return $this;
    }

    /**
     * Set the print max width.
     *
     * @param integer $printMaxWidth The print max width.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setPrintMaxWidth($printMaxWidth) {
        $this->printMaxWidth = $printMaxWidth;
        return $this;
    }

    /**
     * Set the scale.
     *
     * @param integer $scale The scale.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setScale($scale) {
        $this->scale = $scale;
        return $this;
    }

    /**
     * Set the source height.
     *
     * @param integer $sourceHeight The source height.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setSourceHeight($sourceHeight) {
        $this->sourceHeight = $sourceHeight;
        return $this;
    }

    /**
     * Set the source width.
     *
     * @param integer $sourceWidth The source width.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setSourceWidth($sourceWidth) {
        $this->sourceWidth = $sourceWidth;
        return $this;
    }

    /**
     * Set the type.
     *
     * @param string $type The type.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setType($type) {
        switch ($type) {
            case "application/pdf":
            case "image/jpeg":
            case "image/png":
            case "image/svg+xml":
            $this->type = $type;
            break;
        }
        return $this;
    }

    /**
     * Set the url.
     *
     * @param string $url The url.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setUrl($url) {
        $this->url = $url;
        return $this;
    }

    /**
     * Set the width.
     *
     * @param integer $width The width.
     * @return \WBW\Bundle\HighchartsBundle\API\Chart\HighchartsExporting Returns the highcharts exporting.
     */
    public function setWidth($width) {
        $this->width = $width;
        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 allow HTML.
        ArrayUtility::set($output, "allowHTML", $this->allowHTML, [null]);

        // Set the buttons.
        if (null !== $this->buttons) {
            ArrayUtility::set($output, "buttons", $this->buttons->toArray(), []);
        }

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

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

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

        // Set the fallback to export server.
        ArrayUtility::set($output, "fallbackToExportServer", $this->fallbackToExportServer, [null]);

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

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

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

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

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

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

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

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

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

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

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

        // Return the output.
        return $output;
    }

}