DataSeriesValues::refresh() - Code Metrics - Inspection of "Use PHP 7.0 for code coverage" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 870d86...2ad559 )

by Adrien

created 2017-04-21 08:22 UTC

DataSeriesValues::refresh() C

↳ Parent: DataSeriesValues

Complexity

Conditions	12
Paths	8

Size

Total Lines	46
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	30
CRAP Score	12

Importance

Changes

Metric	Value
cc	12
eloc	31
nc	8
nop	2
dl	0
loc	46
rs	5.15
c	0
b	0
f	0
ccs	30
cts	30
cp	1
crap	12

How to fix Complexity

<?php

namespace PhpOffice\PhpSpreadsheet\Chart;

/**
 * Copyright (c) 2006 - 2016 PhpSpreadsheet.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @category    PhpSpreadsheet
 *
 * @copyright    Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
 * @license        http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt    LGPL
 */
class DataSeriesValues
{
    const DATASERIES_TYPE_STRING = 'String';
    const DATASERIES_TYPE_NUMBER = 'Number';

    private static $dataTypeValues = [
        self::DATASERIES_TYPE_STRING,
        self::DATASERIES_TYPE_NUMBER,
    ];

    /**
     * Series Data Type.
     *
     * @var string
     */
    private $dataType;

    /**
     * Series Data Source.
     *
     * @var string
     */
    private $dataSource;

    /**
     * Format Code.
     *
     * @var string
     */
    private $formatCode;

    /**
     * Series Point Marker.
     *
     * @var string
     */
    private $pointMarker;

    /**
     * Point Count (The number of datapoints in the dataseries).
     *
     * @var int
     */
    private $pointCount = 0;

    /**
     * Data Values.
     *
     * @var array of mixed
     */
    private $dataValues = [];

    /**
     * Create a new DataSeriesValues object.
     *
     * @param mixed $dataType
     * @param string $dataSource
     * @param null|mixed $formatCode
     * @param mixed $pointCount
     * @param mixed $dataValues
     * @param null|mixed $marker
     */
    public function __construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null)
    {
        $this->setDataType($dataType);
        $this->dataSource = $dataSource;
        $this->formatCode = $formatCode;
        $this->pointCount = $pointCount;
        $this->dataValues = $dataValues;

        $this->pointMarker = $marker;
    }

    /**
     * Get Series Data Type.
     *
     * @return string
     */
    public function getDataType()
    {
        return $this->dataType;
    }

    /**
     * Set Series Data Type.
     *
     * @param string $dataType Datatype of this data series
     *                                Typical values are:
     *                                    \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING
     *                                        Normally used for axis point values
     *                                    \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER
     *                                        Normally used for chart data values
     *
     * @throws Exception
     *
     * @return DataSeriesValues
     */
    public function setDataType($dataType)
    {
        if (!in_array($dataType, self::$dataTypeValues)) {
            throw new Exception('Invalid datatype for chart data series values');
        }
        $this->dataType = $dataType;

        return $this;
    }

    /**
     * Get Series Data Source (formula).
     *
     * @return string
     */
    public function getDataSource()
    {
        return $this->dataSource;
    }

    /**
     * Set Series Data Source (formula).
     *
     * @param string $dataSource
     *
     * @return DataSeriesValues
     */
    public function setDataSource($dataSource)
    {
        $this->dataSource = $dataSource;

        return $this;
    }

    /**
     * Get Point Marker.
     *
     * @return string
     */
    public function getPointMarker()
    {
        return $this->pointMarker;
    }

    /**
     * Set Point Marker.
     *
     * @param string $marker
     *
     * @return DataSeriesValues
     */
    public function setPointMarker($marker)
    {
        $this->pointMarker = $marker;

        return $this;
    }

    /**
     * Get Series Format Code.
     *
     * @return string
     */
    public function getFormatCode()
    {
        return $this->formatCode;
    }

    /**
     * Set Series Format Code.
     *
     * @param string $formatCode
     *
     * @return DataSeriesValues
     */
    public function setFormatCode($formatCode)
    {
        $this->formatCode = $formatCode;

        return $this;
    }

    /**
     * Get Series Point Count.
     *
     * @return int
     */
    public function getPointCount()
    {
        return $this->pointCount;
    }

    /**
     * Identify if the Data Series is a multi-level or a simple series.
     *
     * @return bool|null
     */
    public function isMultiLevelSeries()
    {
        if (count($this->dataValues) > 0) {
            return is_array($this->dataValues[0]);
        }

        return null;
    }

    /**
     * Return the level count of a multi-level Data Series.
     *
     * @return int
     */
    public function multiLevelCount()
    {
        $levelCount = 0;
        foreach ($this->dataValues as $dataValueSet) {
            $levelCount = max($levelCount, count($dataValueSet));
        }

        return $levelCount;
    }

    /**
     * Get Series Data Values.
     *
     * @return array of mixed
     */
    public function getDataValues()
    {
        return $this->dataValues;
    }

    /**
     * Get the first Series Data value.
     *
     * @return mixed
     */
    public function getDataValue()
    {
        $count = count($this->dataValues);
        if ($count == 0) {
            return null;
        } elseif ($count == 1) {
            return $this->dataValues[0];
        }

        return $this->dataValues;
    }

    /**
     * Set Series Data Values.
     *
     * @param array $dataValues
     *
     * @return DataSeriesValues
     */
    public function setDataValues($dataValues)
    {
        $this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($dataValues);
        $this->pointCount = count($dataValues);

        return $this;
    }

    public function refresh(\PhpOffice\PhpSpreadsheet\Worksheet $worksheet, $flatten = true)
    {
        if ($this->dataSource !== null) {
            $calcEngine = \PhpOffice\PhpSpreadsheet\Calculation::getInstance($worksheet->getParent());
            $newDataValues = \PhpOffice\PhpSpreadsheet\Calculation::unwrapResult(
                $calcEngine->_calculateFormulaValue(
                    '=' . $this->dataSource,
                    null,
                    $worksheet->getCell('A1')
                )
            );
            if ($flatten) {
                $this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($newDataValues);
                foreach ($this->dataValues as &$dataValue) {
                    if ((!empty($dataValue)) && ($dataValue[0] == '#')) {
                        $dataValue = 0.0;
                    }
                }
                unset($dataValue);
            } else {
                $cellRange = explode('!', $this->dataSource);
                if (count($cellRange) > 1) {
                    list(, $cellRange) = $cellRange;
                }

                $dimensions = \PhpOffice\PhpSpreadsheet\Cell::rangeDimension(str_replace('$', '', $cellRange));
                if (($dimensions[0] == 1) || ($dimensions[1] == 1)) {
                    $this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($newDataValues);
                } else {
                    $newArray = array_values(array_shift($newDataValues));
                    foreach ($newArray as $i => $newDataSet) {
                        $newArray[$i] = [$newDataSet];
                    }

                    foreach ($newDataValues as $newDataSet) {
                        $i = 0;
                        foreach ($newDataSet as $newDataVal) {
                            array_unshift($newArray[$i++], $newDataVal);
                        }
                    }
                    $this->dataValues = $newArray;
                }
            }
            $this->pointCount = count($this->dataValues);
        }
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Chart;
4
5		/**
6		* Copyright (c) 2006 - 2016 PhpSpreadsheet.
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU Lesser General Public
10		* License as published by the Free Software Foundation; either
11		* version 2.1 of the License, or (at your option) any later version.
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16		* Lesser General Public License for more details.
17		*
18		* You should have received a copy of the GNU Lesser General Public
19		* License along with this library; if not, write to the Free Software
20		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21		*
22		* @category PhpSpreadsheet
23		*
24		* @copyright Copyright (c) 2006 - 2016 PhpSpreadsheet (https://github.com/PHPOffice/PhpSpreadsheet)
25		* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
26		*/
27		class DataSeriesValues
28		{
29		const DATASERIES_TYPE_STRING = 'String';
30		const DATASERIES_TYPE_NUMBER = 'Number';
31
32		private static $dataTypeValues = [
33		self::DATASERIES_TYPE_STRING,
34		self::DATASERIES_TYPE_NUMBER,
35		];
36
37		/**
38		* Series Data Type.
39		*
40		* @var string
41		*/
42		private $dataType;
43
44		/**
45		* Series Data Source.
46		*
47		* @var string
48		*/
49		private $dataSource;
50
51		/**
52		* Format Code.
53		*
54		* @var string
55		*/
56		private $formatCode;
57
58		/**
59		* Series Point Marker.
60		*
61		* @var string
62		*/
63		private $pointMarker;
64
65		/**
66		* Point Count (The number of datapoints in the dataseries).
67		*
68		* @var int
69		*/
70		private $pointCount = 0;
71
72		/**
73		* Data Values.
74		*
75		* @var array of mixed
76		*/
77		private $dataValues = [];
78
79		/**
80		* Create a new DataSeriesValues object.
81		*
82		* @param mixed $dataType
83		* @param string $dataSource
84		* @param null\|mixed $formatCode
85		* @param mixed $pointCount
86		* @param mixed $dataValues
87		* @param null\|mixed $marker
88		*/
89	17	public function __construct($dataType = self::DATASERIES_TYPE_NUMBER, $dataSource = null, $formatCode = null, $pointCount = 0, $dataValues = [], $marker = null)
90		{
91	17	$this->setDataType($dataType);
92	17	$this->dataSource = $dataSource;
93	17	$this->formatCode = $formatCode;
94	17	$this->pointCount = $pointCount;
95	17	$this->dataValues = $dataValues;
		0 ignored issues – show Documentation Bug introduced 2016-12-22 15:06 UTC by Report Bug Copy Issue Report It seems like `$dataValues` of type `*` is incompatible with the declared type `array` of property `$dataValues`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
96	17	$this->pointMarker = $marker;
97	17	}
98
99		/**
100		* Get Series Data Type.
101		*
102		* @return string
103		*/
104	1	public function getDataType()
105		{
106	1	return $this->dataType;
107		}
108
109		/**
110		* Set Series Data Type.
111		*
112		* @param string $dataType Datatype of this data series
113		* Typical values are:
114		* \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_STRING
115		* Normally used for axis point values
116		* \PhpOffice\PhpSpreadsheet\Chart\DataSeriesValues::DATASERIES_TYPE_NUMBER
117		* Normally used for chart data values
118		*
119		* @throws Exception
120		*
121		* @return DataSeriesValues
122		*/
123	17	public function setDataType($dataType)
124		{
125	17	if (!in_array($dataType, self::$dataTypeValues)) {
126	1	throw new Exception('Invalid datatype for chart data series values');
127		}
128	17	$this->dataType = $dataType;
129
130	17	return $this;
131		}
132
133		/**
134		* Get Series Data Source (formula).
135		*
136		* @return string
137		*/
138	13	public function getDataSource()
139		{
140	13	return $this->dataSource;
141		}
142
143		/**
144		* Set Series Data Source (formula).
145		*
146		* @param string $dataSource
147		*
148		* @return DataSeriesValues
149		*/
150		public function setDataSource($dataSource)
151		{
152		$this->dataSource = $dataSource;
153
154		return $this;
155		}
156
157		/**
158		* Get Point Marker.
159		*
160		* @return string
161		*/
162	13	public function getPointMarker()
163		{
164	13	return $this->pointMarker;
165		}
166
167		/**
168		* Set Point Marker.
169		*
170		* @param string $marker
171		*
172		* @return DataSeriesValues
173		*/
174		public function setPointMarker($marker)
175		{
176		$this->pointMarker = $marker;
177
178		return $this;
179		}
180
181		/**
182		* Get Series Format Code.
183		*
184		* @return string
185		*/
186	12	public function getFormatCode()
187		{
188	12	return $this->formatCode;
189		}
190
191		/**
192		* Set Series Format Code.
193		*
194		* @param string $formatCode
195		*
196		* @return DataSeriesValues
197		*/
198		public function setFormatCode($formatCode)
199		{
200		$this->formatCode = $formatCode;
201
202		return $this;
203		}
204
205		/**
206		* Get Series Point Count.
207		*
208		* @return int
209		*/
210	13	public function getPointCount()
211		{
212	13	return $this->pointCount;
213		}
214
215		/**
216		* Identify if the Data Series is a multi-level or a simple series.
217		*
218		* @return bool\|null
219		*/
220	13	public function isMultiLevelSeries()
221		{
222	13	if (count($this->dataValues) > 0) {
223	13	return is_array($this->dataValues[0]);
224		}
225
226		return null;
227		}
228
229		/**
230		* Return the level count of a multi-level Data Series.
231		*
232		* @return int
233		*/
234	2	public function multiLevelCount()
235		{
236	2	$levelCount = 0;
237	2	foreach ($this->dataValues as $dataValueSet) {
238	2	$levelCount = max($levelCount, count($dataValueSet));
239		}
240
241	2	return $levelCount;
242		}
243
244		/**
245		* Get Series Data Values.
246		*
247		* @return array of mixed
248		*/
249	13	public function getDataValues()
250		{
251	13	return $this->dataValues;
252		}
253
254		/**
255		* Get the first Series Data value.
256		*
257		* @return mixed
258		*/
259		public function getDataValue()
260		{
261		$count = count($this->dataValues);
262		if ($count == 0) {
263		return null;
264		} elseif ($count == 1) {
265		return $this->dataValues[0];
266		}
267
268		return $this->dataValues;
269		}
270
271		/**
272		* Set Series Data Values.
273		*
274		* @param array $dataValues
275		*
276		* @return DataSeriesValues
277		*/
278		public function setDataValues($dataValues)
279		{
280		$this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($dataValues);
281		$this->pointCount = count($dataValues);
282
283		return $this;
284		}
285
286	13	public function refresh(\PhpOffice\PhpSpreadsheet\Worksheet $worksheet, $flatten = true)
287		{
288	13	if ($this->dataSource !== null) {
289	13	$calcEngine = \PhpOffice\PhpSpreadsheet\Calculation::getInstance($worksheet->getParent());
290	13	$newDataValues = \PhpOffice\PhpSpreadsheet\Calculation::unwrapResult(
291	13	$calcEngine->_calculateFormulaValue(
292	13	'=' . $this->dataSource,
293	13	null,
294	13	$worksheet->getCell('A1')
295		)
296		);
297	13	if ($flatten) {
298	13	$this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($newDataValues);
299	13	foreach ($this->dataValues as &$dataValue) {
300	13	if ((!empty($dataValue)) && ($dataValue[0] == '#')) {
301	13	$dataValue = 0.0;
302		}
303		}
304	13	unset($dataValue);
305		} else {
306	13	$cellRange = explode('!', $this->dataSource);
307	13	if (count($cellRange) > 1) {
308	13	list(, $cellRange) = $cellRange;
309		}
310
311	13	$dimensions = \PhpOffice\PhpSpreadsheet\Cell::rangeDimension(str_replace('$', '', $cellRange));
312	13	if (($dimensions[0] == 1) \|\| ($dimensions[1] == 1)) {
313	12	$this->dataValues = \PhpOffice\PhpSpreadsheet\Calculation\Functions::flattenArray($newDataValues);
314		} else {
315	2	$newArray = array_values(array_shift($newDataValues));
316	2	foreach ($newArray as $i => $newDataSet) {
317	2	$newArray[$i] = [$newDataSet];
318		}
319
320	2	foreach ($newDataValues as $newDataSet) {
321	2	$i = 0;
322	2	foreach ($newDataSet as $newDataVal) {
323	2	array_unshift($newArray[$i++], $newDataVal);
324		}
325		}
326	2	$this->dataValues = $newArray;
327		}
328		}
329	13	$this->pointCount = count($this->dataValues);
330		}
331	13	}
332		}
333

PHPOffice / PhpSpreadsheet

Push — develop ( 870d86...2ad559 )

DataSeriesValues::refresh() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like