Functions::flattenArray() - Code Metrics - Inspection of "CHOOSECOLS, CHOOSEROWS, DROP, TAKE, and EXPAND" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4286)

by Owen

created 2024-12-22 17:03 UTC

Functions::flattenArray() A

↳ Parent: Functions

Complexity

Conditions	4
Paths	4

Size

Total Lines	20
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	11
c	0
b	0
f	0
nc	4
nop	1
dl	0
loc	20
rs	9.9
ccs	11
cts	11
cp	1
crap	4

<?php

namespace PhpOffice\PhpSpreadsheet\Calculation;

use PhpOffice\PhpSpreadsheet\Cell\Cell;
use PhpOffice\PhpSpreadsheet\Shared\Date;

class Functions
{
    const PRECISION = 8.88E-016;

    /**
     * 2 / PI.
     */
    const M_2DIVPI = 0.63661977236758134307553505349006;

    const COMPATIBILITY_EXCEL = 'Excel';
    const COMPATIBILITY_GNUMERIC = 'Gnumeric';
    const COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc';

    /** Use of RETURNDATE_PHP_NUMERIC is discouraged - not 32-bit Y2038-safe, no timezone. */
    const RETURNDATE_PHP_NUMERIC = 'P';
    /** Use of RETURNDATE_UNIX_TIMESTAMP is discouraged - not 32-bit Y2038-safe, no timezone. */
    const RETURNDATE_UNIX_TIMESTAMP = 'P';
    const RETURNDATE_PHP_OBJECT = 'O';
    const RETURNDATE_PHP_DATETIME_OBJECT = 'O';
    const RETURNDATE_EXCEL = 'E';

    public const NOT_YET_IMPLEMENTED = '#Not Yet Implemented';

    /**
     * Compatibility mode to use for error checking and responses.
     */
    protected static string $compatibilityMode = self::COMPATIBILITY_EXCEL;

    /**
     * Data Type to use when returning date values.
     */
    protected static string $returnDateType = self::RETURNDATE_EXCEL;

    /**
     * Set the Compatibility Mode.
     *
     * @param string $compatibilityMode Compatibility Mode
     *                                  Permitted values are:
     *                                      Functions::COMPATIBILITY_EXCEL        'Excel'
     *                                      Functions::COMPATIBILITY_GNUMERIC     'Gnumeric'
     *                                      Functions::COMPATIBILITY_OPENOFFICE   'OpenOfficeCalc'
     *
     * @return bool (Success or Failure)
     */
    public static function setCompatibilityMode(string $compatibilityMode): bool
    {
        if (
            ($compatibilityMode == self::COMPATIBILITY_EXCEL)
            || ($compatibilityMode == self::COMPATIBILITY_GNUMERIC)
            || ($compatibilityMode == self::COMPATIBILITY_OPENOFFICE)
        ) {
            self::$compatibilityMode = $compatibilityMode;

            return true;
        }

        return false;
    }

    /**
     * Return the current Compatibility Mode.
     *
     * @return string Compatibility Mode
     *                Possible Return values are:
     *                    Functions::COMPATIBILITY_EXCEL        'Excel'
     *                    Functions::COMPATIBILITY_GNUMERIC     'Gnumeric'
     *                    Functions::COMPATIBILITY_OPENOFFICE   'OpenOfficeCalc'
     */
    public static function getCompatibilityMode(): string
    {
        return self::$compatibilityMode;
    }

    /**
     * Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP DateTime Object).
     *
     * @param string $returnDateType Return Date Format
     *                               Permitted values are:
     *                                   Functions::RETURNDATE_UNIX_TIMESTAMP       'P'
     *                                   Functions::RETURNDATE_PHP_DATETIME_OBJECT  'O'
     *                                   Functions::RETURNDATE_EXCEL                'E'
     *
     * @return bool Success or failure
     */
    public static function setReturnDateType(string $returnDateType): bool
    {
        if (
            ($returnDateType == self::RETURNDATE_UNIX_TIMESTAMP)
            || ($returnDateType == self::RETURNDATE_PHP_DATETIME_OBJECT)
            || ($returnDateType == self::RETURNDATE_EXCEL)
        ) {
            self::$returnDateType = $returnDateType;

            return true;
        }

        return false;
    }

    /**
     * Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).
     *
     * @return string Return Date Format
     *                Possible Return values are:
     *                    Functions::RETURNDATE_UNIX_TIMESTAMP         'P'
     *                    Functions::RETURNDATE_PHP_DATETIME_OBJECT    'O'
     *                    Functions::RETURNDATE_EXCEL            '     'E'
     */
    public static function getReturnDateType(): string
    {
        return self::$returnDateType;
    }

    /**
     * DUMMY.
     *
     * @return string #Not Yet Implemented
     */
    public static function DUMMY(): string
    {
        return self::NOT_YET_IMPLEMENTED;
    }

    public static function isMatrixValue(mixed $idx): bool
    {
        return (substr_count($idx, '.') <= 1) || (preg_match('/\.[A-Z]/', $idx) > 0);
    }

    public static function isValue(mixed $idx): bool
    {
        return substr_count($idx, '.') === 0;
    }

    public static function isCellValue(mixed $idx): bool
    {
        return substr_count($idx, '.') > 1;
    }

    public static function ifCondition(mixed $condition): string
    {
        $condition = self::flattenSingleValue($condition);

        if ($condition === '' || $condition === null) {
            return '=""';
        }
        if (!is_string($condition) || !in_array($condition[0], ['>', '<', '='], true)) {
            $condition = self::operandSpecialHandling($condition);
            if (is_bool($condition)) {
                return '=' . ($condition ? 'TRUE' : 'FALSE');
            } elseif (!is_numeric($condition)) {
                if ($condition !== '""') { // Not an empty string
                    // Escape any quotes in the string value
                    $condition = (string) preg_replace('/"/ui', '""', $condition);
                }
                $condition = Calculation::wrapResult(strtoupper($condition));
            }

            return str_replace('""""', '""', '=' . $condition);
        }
        $operator = $operand = '';
        if (1 === preg_match('/(=|<[>=]?|>=?)(.*)/', $condition, $matches)) {
            [, $operator, $operand] = $matches;
        }

        $operand = self::operandSpecialHandling($operand);
        if (is_numeric(trim($operand, '"'))) {
            $operand = trim($operand, '"');
        } elseif (!is_numeric($operand) && $operand !== 'FALSE' && $operand !== 'TRUE') {
            $operand = str_replace('"', '""', $operand);
            $operand = Calculation::wrapResult(strtoupper($operand));
        }

        return str_replace('""""', '""', $operator . $operand);
    }

    private static function operandSpecialHandling(mixed $operand): mixed
    {
        if (is_numeric($operand) || is_bool($operand)) {
            return $operand;
        } elseif (strtoupper($operand) === Calculation::getTRUE() || strtoupper($operand) === Calculation::getFALSE()) {
            return strtoupper($operand);
        }

        // Check for percentage
        if (preg_match('/^\-?\d*\.?\d*\s?\%$/', $operand)) {
            return ((float) rtrim($operand, '%')) / 100;
        }

        // Check for dates
        if (($dateValueOperand = Date::stringToExcel($operand)) !== false) {
            return $dateValueOperand;
        }

        return $operand;
    }

    /**
     * Convert a multi-dimensional array to a simple 1-dimensional array.
     *
     * @param mixed $array Array to be flattened
     *
     * @return array Flattened array
     */
    public static function flattenArray(mixed $array): array
    {
        if (!is_array($array)) {
            return (array) $array;
        }

        $flattened = [];
        $stack = array_values($array);

        while (!empty($stack)) {
            $value = array_shift($stack);

            if (is_array($value)) {
                array_unshift($stack, ...array_values($value));
            } else {
                $flattened[] = $value;
            }
        }

        return $flattened;
    }

    /**
     * Convert a multi-dimensional array to a simple 1-dimensional array.
     * Same as above but argument is specified in ... format.
     *
     * @param mixed $array Array to be flattened
     *
     * @return array Flattened array
     */
    public static function flattenArray2(mixed ...$array): array
    {
        $flattened = [];
        $stack = array_values($array);

        while (!empty($stack)) {
            $value = array_shift($stack);

            if (is_array($value)) {
                array_unshift($stack, ...array_values($value));
            } else {
                $flattened[] = $value;
            }
        }

        return $flattened;
    }

    public static function scalar(mixed $value): mixed
    {
        if (!is_array($value)) {
            return $value;
        }

        do {
            $value = array_pop($value);
        } while (is_array($value));

        return $value;
    }

    /**
     * Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
     *
     * @param array|mixed $array Array to be flattened
     *
     * @return array Flattened array
     */
    public static function flattenArrayIndexed($array): array
    {
        if (!is_array($array)) {
            return (array) $array;
        }

        $arrayValues = [];
        foreach ($array as $k1 => $value) {
            if (is_array($value)) {
                foreach ($value as $k2 => $val) {
                    if (is_array($val)) {
                        foreach ($val as $k3 => $v) {
                            $arrayValues[$k1 . '.' . $k2 . '.' . $k3] = $v;
                        }
                    } else {
                        $arrayValues[$k1 . '.' . $k2] = $val;
                    }
                }
            } else {
                $arrayValues[$k1] = $value;
            }
        }

        return $arrayValues;
    }

    /**
     * Convert an array to a single scalar value by extracting the first element.
     *
     * @param mixed $value Array or scalar value
     */
    public static function flattenSingleValue(mixed $value): mixed
    {
        while (is_array($value)) {
            $value = array_shift($value);
        }

        return $value;
    }

    public static function expandDefinedName(string $coordinate, Cell $cell): string
    {
        $worksheet = $cell->getWorksheet();
        $spreadsheet = $worksheet->getParentOrThrow();
        // Uppercase coordinate
        $pCoordinatex = strtoupper($coordinate);
        // Eliminate leading equal sign
        $pCoordinatex = (string) preg_replace('/^=/', '', $pCoordinatex);
        $defined = $spreadsheet->getDefinedName($pCoordinatex, $worksheet);
        if ($defined !== null) {
            $worksheet2 = $defined->getWorkSheet();
            if (!$defined->isFormula() && $worksheet2 !== null) {
                $coordinate = "'" . $worksheet2->getTitle() . "'!"
                    . (string) preg_replace('/^=/', '', str_replace('$', '', $defined->getValue()));
            }
        }

        return $coordinate;
    }

    public static function trimTrailingRange(string $coordinate): string
    {
        return (string) preg_replace('/:[\\w\$]+$/', '', $coordinate);
    }

    public static function trimSheetFromCellReference(string $coordinate): string
    {
        if (str_contains($coordinate, '!')) {
            $coordinate = substr($coordinate, strrpos($coordinate, '!') + 1);
        }

        return $coordinate;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Calculation;
4
5		use PhpOffice\PhpSpreadsheet\Cell\Cell;
6		use PhpOffice\PhpSpreadsheet\Shared\Date;
7
8		class Functions
9		{
10		const PRECISION = 8.88E-016;
11
12		/**
13		* 2 / PI.
14		*/
15		const M_2DIVPI = 0.63661977236758134307553505349006;
16
17		const COMPATIBILITY_EXCEL = 'Excel';
18		const COMPATIBILITY_GNUMERIC = 'Gnumeric';
19		const COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc';
20
21		/** Use of RETURNDATE_PHP_NUMERIC is discouraged - not 32-bit Y2038-safe, no timezone. */
22		const RETURNDATE_PHP_NUMERIC = 'P';
23		/** Use of RETURNDATE_UNIX_TIMESTAMP is discouraged - not 32-bit Y2038-safe, no timezone. */
24		const RETURNDATE_UNIX_TIMESTAMP = 'P';
25		const RETURNDATE_PHP_OBJECT = 'O';
26		const RETURNDATE_PHP_DATETIME_OBJECT = 'O';
27		const RETURNDATE_EXCEL = 'E';
28
29		public const NOT_YET_IMPLEMENTED = '#Not Yet Implemented';
30
31		/**
32		* Compatibility mode to use for error checking and responses.
33		*/
34		protected static string $compatibilityMode = self::COMPATIBILITY_EXCEL;
35
36		/**
37		* Data Type to use when returning date values.
38		*/
39		protected static string $returnDateType = self::RETURNDATE_EXCEL;
40
41		/**
42		* Set the Compatibility Mode.
43		*
44		* @param string $compatibilityMode Compatibility Mode
45		* Permitted values are:
46		* Functions::COMPATIBILITY_EXCEL 'Excel'
47		* Functions::COMPATIBILITY_GNUMERIC 'Gnumeric'
48		* Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'
49		*
50		* @return bool (Success or Failure)
51		*/
52	8296	public static function setCompatibilityMode(string $compatibilityMode): bool
53		{
54		if (
55	8296	($compatibilityMode == self::COMPATIBILITY_EXCEL)
56	8296	\|\| ($compatibilityMode == self::COMPATIBILITY_GNUMERIC)
57	8296	\|\| ($compatibilityMode == self::COMPATIBILITY_OPENOFFICE)
58		) {
59	8296	self::$compatibilityMode = $compatibilityMode;
60
61	8296	return true;
62		}
63
64	1	return false;
65		}
66
67		/**
68		* Return the current Compatibility Mode.
69		*
70		* @return string Compatibility Mode
71		* Possible Return values are:
72		* Functions::COMPATIBILITY_EXCEL 'Excel'
73		* Functions::COMPATIBILITY_GNUMERIC 'Gnumeric'
74		* Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'
75		*/
76	9555	public static function getCompatibilityMode(): string
77		{
78	9555	return self::$compatibilityMode;
79		}
80
81		/**
82		* Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP DateTime Object).
83		*
84		* @param string $returnDateType Return Date Format
85		* Permitted values are:
86		* Functions::RETURNDATE_UNIX_TIMESTAMP 'P'
87		* Functions::RETURNDATE_PHP_DATETIME_OBJECT 'O'
88		* Functions::RETURNDATE_EXCEL 'E'
89		*
90		* @return bool Success or failure
91		*/
92	3217	public static function setReturnDateType(string $returnDateType): bool
93		{
94		if (
95	3217	($returnDateType == self::RETURNDATE_UNIX_TIMESTAMP)
96	3217	\|\| ($returnDateType == self::RETURNDATE_PHP_DATETIME_OBJECT)
97	3217	\|\| ($returnDateType == self::RETURNDATE_EXCEL)
98		) {
99	3217	self::$returnDateType = $returnDateType;
100
101	3217	return true;
102		}
103
104	1	return false;
105		}
106
107		/**
108		* Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object).
109		*
110		* @return string Return Date Format
111		* Possible Return values are:
112		* Functions::RETURNDATE_UNIX_TIMESTAMP 'P'
113		* Functions::RETURNDATE_PHP_DATETIME_OBJECT 'O'
114		* Functions::RETURNDATE_EXCEL ' 'E'
115		*/
116	3330	public static function getReturnDateType(): string
117		{
118	3330	return self::$returnDateType;
119		}
120
121		/**
122		* DUMMY.
123		*
124		* @return string #Not Yet Implemented
125		*/
126	15	public static function DUMMY(): string
127		{
128	15	return self::NOT_YET_IMPLEMENTED;
129		}
130
131	5	public static function isMatrixValue(mixed $idx): bool
132		{
133	5	return (substr_count($idx, '.') <= 1) \|\| (preg_match('/\.[A-Z]/', $idx) > 0);
134		}
135
136	1	public static function isValue(mixed $idx): bool
137		{
138	1	return substr_count($idx, '.') === 0;
139		}
140
141	102	public static function isCellValue(mixed $idx): bool
142		{
143	102	return substr_count($idx, '.') > 1;
144		}
145
146	209	public static function ifCondition(mixed $condition): string
147		{
148	209	$condition = self::flattenSingleValue($condition);
149
150	209	if ($condition === '' \|\| $condition === null) {
151	3	return '=""';
152		}
153	208	if (!is_string($condition) \|\| !in_array($condition[0], ['>', '<', '='], true)) {
154	118	$condition = self::operandSpecialHandling($condition);
155	118	if (is_bool($condition)) {
156	3	return '=' . ($condition ? 'TRUE' : 'FALSE');
157	115	} elseif (!is_numeric($condition)) {
158	95	if ($condition !== '""') { // Not an empty string
159		// Escape any quotes in the string value
160	94	$condition = (string) preg_replace('/"/ui', '""', $condition);
161		}
162	95	$condition = Calculation::wrapResult(strtoupper($condition));
163		}
164
165	115	return str_replace('""""', '""', '=' . $condition);
166		}
167	126	$operator = $operand = '';
168	126	if (1 === preg_match('/(=\|<[>=]?\|>=?)(.*)/', $condition, $matches)) {
169	126	[, $operator, $operand] = $matches;
170		}
171
172	126	$operand = self::operandSpecialHandling($operand);
173	126	if (is_numeric(trim($operand, '"'))) {
174	73	$operand = trim($operand, '"');
175	80	} elseif (!is_numeric($operand) && $operand !== 'FALSE' && $operand !== 'TRUE') {
176	76	$operand = str_replace('"', '""', $operand);
177	76	$operand = Calculation::wrapResult(strtoupper($operand));
178		}
179
180	126	return str_replace('""""', '""', $operator . $operand);
181		}
182
183	208	private static function operandSpecialHandling(mixed $operand): mixed
184		{
185	208	if (is_numeric($operand) \|\| is_bool($operand)) {
186	111	return $operand;
187	171	} elseif (strtoupper($operand) === Calculation::getTRUE() \|\| strtoupper($operand) === Calculation::getFALSE()) {
188	4	return strtoupper($operand);
189		}
190
191		// Check for percentage
192	167	if (preg_match('/^\-?\d\.?\d\s?\%$/', $operand)) {
193	4	return ((float) rtrim($operand, '%')) / 100;
194		}
195
196		// Check for dates
197	167	if (($dateValueOperand = Date::stringToExcel($operand)) !== false) {
198	4	return $dateValueOperand;
199		}
200
201	167	return $operand;
202		}
203
204		/**
205		* Convert a multi-dimensional array to a simple 1-dimensional array.
206		*
207		* @param mixed $array Array to be flattened
208		*
209		* @return array Flattened array
210		*/
211	6000	public static function flattenArray(mixed $array): array
212		{
213	6000	if (!is_array($array)) {
214	24	return (array) $array;
215		}
216
217	5990	$flattened = [];
218	5990	$stack = array_values($array);
219
220	5990	while (!empty($stack)) {
221	5885	$value = array_shift($stack);
222
223	5885	if (is_array($value)) {
224	2513	array_unshift($stack, ...array_values($value));
225		} else {
226	5882	$flattened[] = $value;
227		}
228		}
229
230	5990	return $flattened;
231		}
232
233		/**
234		* Convert a multi-dimensional array to a simple 1-dimensional array.
235		* Same as above but argument is specified in ... format.
236		*
237		* @param mixed $array Array to be flattened
238		*
239		* @return array Flattened array
240		*/
241	33	public static function flattenArray2(mixed ...$array): array
242		{
243	33	$flattened = [];
244	33	$stack = array_values($array);
245
246	33	while (!empty($stack)) {
247	33	$value = array_shift($stack);
248
249	33	if (is_array($value)) {
250	10	array_unshift($stack, ...array_values($value));
251		} else {
252	33	$flattened[] = $value;
253		}
254		}
255
256	33	return $flattened;
257		}
258
259	724	public static function scalar(mixed $value): mixed
260		{
261	724	if (!is_array($value)) {
262	723	return $value;
263		}
264
265		do {
266	1	$value = array_pop($value);
267	1	} while (is_array($value));
268
269	1	return $value;
270		}
271
272		/**
273		* Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing.
274		*
275		* @param array\|mixed $array Array to be flattened
276		*
277		* @return array Flattened array
278		*/
279	755	public static function flattenArrayIndexed($array): array
280		{
281	755	if (!is_array($array)) {
282	12	return (array) $array;
283		}
284
285	744	$arrayValues = [];
286	744	foreach ($array as $k1 => $value) {
287	744	if (is_array($value)) {
288	546	foreach ($value as $k2 => $val) {
289	542	if (is_array($val)) {
290	496	foreach ($val as $k3 => $v) {
291	489	$arrayValues[$k1 . '.' . $k2 . '.' . $k3] = $v;
292		}
293		} else {
294	63	$arrayValues[$k1 . '.' . $k2] = $val;
295		}
296		}
297		} else {
298	314	$arrayValues[$k1] = $value;
299		}
300		}
301
302	744	return $arrayValues;
303		}
304
305		/**
306		* Convert an array to a single scalar value by extracting the first element.
307		*
308		* @param mixed $value Array or scalar value
309		*/
310	12439	public static function flattenSingleValue(mixed $value): mixed
311		{
312	12439	while (is_array($value)) {
313	7305	$value = array_shift($value);
314		}
315
316	12439	return $value;
317		}
318
319	10	public static function expandDefinedName(string $coordinate, Cell $cell): string
320		{
321	10	$worksheet = $cell->getWorksheet();
322	10	$spreadsheet = $worksheet->getParentOrThrow();
323		// Uppercase coordinate
324	10	$pCoordinatex = strtoupper($coordinate);
325		// Eliminate leading equal sign
326	10	$pCoordinatex = (string) preg_replace('/^=/', '', $pCoordinatex);
327	10	$defined = $spreadsheet->getDefinedName($pCoordinatex, $worksheet);
328	10	if ($defined !== null) {
329	2	$worksheet2 = $defined->getWorkSheet();
330	2	if (!$defined->isFormula() && $worksheet2 !== null) {
331	2	$coordinate = "'" . $worksheet2->getTitle() . "'!"
332	2	. (string) preg_replace('/^=/', '', str_replace('$', '', $defined->getValue()));
333		}
334		}
335
336	10	return $coordinate;
337		}
338
339	5	public static function trimTrailingRange(string $coordinate): string
340		{
341	5	return (string) preg_replace('/:[\\w\$]+$/', '', $coordinate);
342		}
343
344	10073	public static function trimSheetFromCellReference(string $coordinate): string
345		{
346	10073	if (str_contains($coordinate, '!')) {
347	10	$coordinate = substr($coordinate, strrpos($coordinate, '!') + 1);
348		}
349
350	10073	return $coordinate;
351		}
352		}
353

PHPOffice / PhpSpreadsheet

Pull Request — master (#4286)

Functions::flattenArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like