OptionsArray::__toString() - Code Metrics - Inspection of "Fix new property names on 6.0 for the custom seria..." - phpmyadmin/sql-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6c3f09...c54108 )

by William

created 2023-03-28 13:50 UTC

OptionsArray::__toString() A

↳ Parent: OptionsArray

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace PhpMyAdmin\SqlParser\Components;

use PhpMyAdmin\SqlParser\Component;
use PhpMyAdmin\SqlParser\Parser;
use PhpMyAdmin\SqlParser\Token;
use PhpMyAdmin\SqlParser\TokensList;
use PhpMyAdmin\SqlParser\Translator;

use function array_merge_recursive;
use function count;
use function implode;
use function is_array;
use function ksort;
use function sprintf;
use function strcasecmp;
use function strtoupper;

/**
 * Parses a list of options.
 */
final class OptionsArray implements Component
{
    /**
     * ArrayObj of selected options.
     *
     * @var array<int, mixed>
     */
    public $options = [];

    /**
     * @param array<int, mixed> $options The array of options. Options that have a value
     *                       must be an array with at least two keys `name` and
     *                       `expr` or `value`.
     */
    public function __construct(array $options = [])
    {
        $this->options = $options;
    }

    /**
     * @param Parser               $parser  the parser that serves as context
     * @param TokensList           $list    the list of tokens that are being parsed
     * @param array<string, mixed> $options parameters for parsing
     *
     * @return OptionsArray
     */
    public static function parse(Parser $parser, TokensList $list, array $options = [])
    {
        $ret = new static();

        /**
         * The ID that will be assigned to duplicate options.
         *
         * @var int
         */
        $lastAssignedId = count($options) + 1;

        /**
         * The option that was processed last time.
         */
        $lastOption = null;

        /**
         * The index of the option that was processed last time.
         *
         * @var int
         */
        $lastOptionId = 0;

        /**
         * Counts brackets.
         *
         * @var int
         */
        $brackets = 0;

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 ---------------------[ option ]----------------------> 1
         *
         *      1 -------------------[ = (optional) ]------------------> 2
         *
         *      2 ----------------------[ value ]----------------------> 0
         *
         * @var int
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             */
            $token = $list->tokens[$list->idx];

            // End of statement.
            if ($token->type === Token::TYPE_DELIMITER) {
                break;
            }

            // Skipping comments.
            if ($token->type === Token::TYPE_COMMENT) {
                continue;
            }

            // Skipping whitespace if not parsing value.
            if (($token->type === Token::TYPE_WHITESPACE) && ($brackets === 0)) {
                continue;
            }

            if ($lastOption === null) {
                $upper = strtoupper($token->token);
                if (! isset($options[$upper])) {
                    // There is no option to be processed.
                    break;
                }

                $lastOption = $options[$upper];
                $lastOptionId = is_array($lastOption) ?
                    $lastOption[0] : $lastOption;
                $state = 0;

                // Checking for option conflicts.
                // For example, in `SELECT` statements the keywords `ALL`
                // and `DISTINCT` conflict and if used together, they
                // produce an invalid query.
                //
                // Usually, tokens can be identified in the array by the
                // option ID, but if conflicts occur, a generated option ID
                // is used.
                //
                // The first pseudo duplicate ID is the maximum value of the
                // real options (e.g.  if there are 5 options, the first
                // fake ID is 6).
                if (isset($ret->options[$lastOptionId])) {
                    $parser->error(
                        sprintf(
                            Translator::gettext('This option conflicts with "%1$s".'),
                            is_array($ret->options[$lastOptionId])
                            ? $ret->options[$lastOptionId]['name']
                            : $ret->options[$lastOptionId]
                        ),
                        $token
                    );
                    $lastOptionId = $lastAssignedId++;
                }
            }

            if ($state === 0) {
                if (! is_array($lastOption)) {
                    // This is a just keyword option without any value.
                    // This is the beginning and the end of it.
                    $ret->options[$lastOptionId] = $token->value;
                    $lastOption = null;
                    $state = 0;
                } elseif (($lastOption[1] === 'var') || ($lastOption[1] === 'var=')) {
                    // This is a keyword that is followed by a value.
                    // This is only the beginning. The value is parsed in state
                    // 1 and 2. State 1 is used to skip the first equals sign
                    // and state 2 to parse the actual value.
                    $ret->options[$lastOptionId] = [
                        // @var string The name of the option.
                        'name' => $token->value,
                        // @var bool Whether it contains an equal sign.
                        //           This is used by the builder to rebuild it.
                        'equals' => $lastOption[1] === 'var=',
                        // @var string Raw value.
                        'expr' => '',
                        // @var string Processed value.
                        'value' => '',
                    ];
                    $state = 1;
                } elseif ($lastOption[1] === 'expr' || $lastOption[1] === 'expr=') {
                    // This is a keyword that is followed by an expression.
                    // The expression is used by the specialized parser.

                    // Skipping this option in order to parse the expression.
                    ++$list->idx;
                    $ret->options[$lastOptionId] = [
                        // @var string The name of the option.
                        'name' => $token->value,
                        // @var bool Whether it contains an equal sign.
                        //           This is used by the builder to rebuild it.
                        'equals' => $lastOption[1] === 'expr=',
                        // @var Expression The parsed expression.
                        'expr' => '',
                    ];
                    $state = 1;
                }
            } elseif ($state === 1) {
                $state = 2;
                if ($token->token === '=') {
                    $ret->options[$lastOptionId]['equals'] = true;
                    continue;
                }
            }

            // This is outside the `elseif` group above because the change might
            // change this iteration.
            if ($state !== 2) {
                continue;
            }

            if ($lastOption[1] === 'expr' || $lastOption[1] === 'expr=') {
                $ret->options[$lastOptionId]['expr'] = Expression::parse(
                    $parser,
                    $list,
                    empty($lastOption[2]) ? [] : $lastOption[2]
                );
                if ($ret->options[$lastOptionId]['expr'] !== null) {
                    $ret->options[$lastOptionId]['value']
                        = $ret->options[$lastOptionId]['expr']->expr;
                }

                $lastOption = null;
                $state = 0;
            } else {
                if ($token->token === '(') {
                    ++$brackets;
                } elseif ($token->token === ')') {
                    --$brackets;
                }

                $ret->options[$lastOptionId]['expr'] .= $token->token;

                if (
                    ! (($token->token === '(') && ($brackets === 1)
                    || (($token->token === ')') && ($brackets === 0)))
                ) {
                    // First pair of brackets is being skipped.
                    $ret->options[$lastOptionId]['value'] .= $token->value;
                }

                // Checking if we finished parsing.
                if ($brackets === 0) {
                    $lastOption = null;
                }
            }
        }

        /*
         * We reached the end of statement without getting a value
         * for an option for which a value was required
         */
        if (
            $state === 1

            && $lastOption
            && ($lastOption[1] === 'expr'
            || $lastOption[1] === 'var'
            || $lastOption[1] === 'var='
            || $lastOption[1] === 'expr=')
        ) {
            $parser->error(
                sprintf(
                    'Value/Expression for the option %1$s was expected.',
                    $ret->options[$lastOptionId]['name']
                ),
                $list->tokens[$list->idx - 1]
            );
        }

        if (empty($options['_UNSORTED'])) {
            ksort($ret->options);
        }

        --$list->idx;

        return $ret;
    }

    /**
     * @param OptionsArray         $component the component to be built
     * @param array<string, mixed> $options   parameters for building
     */
    public static function build($component, array $options = []): string
    {
        if (empty($component->options)) {
            return '';
        }

        $options = [];
        foreach ($component->options as $option) {
            if (! is_array($option)) {
                $options[] = $option;
            } else {
                $options[] = $option['name']
                    . (! empty($option['equals']) && $option['equals'] ? '=' : ' ')
                    . (! empty($option['expr']) ? $option['expr'] : $option['value']);
            }
        }

        return implode(' ', $options);
    }

    /**
     * Checks if it has the specified option and returns it value or true.
     *
     * @param string $key     the key to be checked
     * @param bool   $getExpr Gets the expression instead of the value.
     *                        The value is the processed form of the expression.
     *
     * @return mixed
     */
    public function has($key, $getExpr = false)
    {
        foreach ($this->options as $option) {
            if (is_array($option)) {
                if (! strcasecmp($key, $option['name'])) {
                    return $getExpr ? $option['expr'] : $option['value'];
                }
            } elseif (! strcasecmp($key, $option)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Removes the option from the array.
     *
     * @param string $key the key to be removed
     *
     * @return bool whether the key was found and deleted or not
     */
    public function remove($key)
    {
        foreach ($this->options as $idx => $option) {
            if (is_array($option)) {
                if (! strcasecmp($key, $option['name'])) {
                    unset($this->options[$idx]);

                    return true;
                }
            } elseif (! strcasecmp($key, $option)) {
                unset($this->options[$idx]);

                return true;
            }
        }

        return false;
    }

    /**
     * Merges the specified options with these ones. Values with same ID will be
     * replaced.
     *
     * @param array<int, mixed>|OptionsArray $options the options to be merged
     *
     * @return void
     */
    public function merge($options)
    {
        if (is_array($options)) {
            $this->options = array_merge_recursive($this->options, $options);
        } elseif ($options instanceof self) {

            $this->options = array_merge_recursive($this->options, $options->options);
        }
    }

    /**
     * Checks tf there are no options set.
     *
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->options);
    }

    public function __toString(): string
    {
        return static::build($this);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace PhpMyAdmin\SqlParser\Components;
6
7		use PhpMyAdmin\SqlParser\Component;
8		use PhpMyAdmin\SqlParser\Parser;
9		use PhpMyAdmin\SqlParser\Token;
10		use PhpMyAdmin\SqlParser\TokensList;
11		use PhpMyAdmin\SqlParser\Translator;
12
13		use function array_merge_recursive;
14		use function count;
15		use function implode;
16		use function is_array;
17		use function ksort;
18		use function sprintf;
19		use function strcasecmp;
20		use function strtoupper;
21
22		/**
23		* Parses a list of options.
24		*/
25		final class OptionsArray implements Component
26		{
27		/**
28		* ArrayObj of selected options.
29		*
30		* @var array<int, mixed>
31		*/
32		public $options = [];
33
34		/**
35		* @param array<int, mixed> $options The array of options. Options that have a value
36		* must be an array with at least two keys `name` and
37		* `expr` or `value`.
38		*/
39	1014	public function __construct(array $options = [])
40		{
41	1014	$this->options = $options;
42		}
43
44		/**
45		* @param Parser $parser the parser that serves as context
46		* @param TokensList $list the list of tokens that are being parsed
47		* @param array<string, mixed> $options parameters for parsing
48		*
49		* @return OptionsArray
50		*/
51	1006	public static function parse(Parser $parser, TokensList $list, array $options = [])
52		{
53	1006	$ret = new static();
54
55		/**
56		* The ID that will be assigned to duplicate options.
57		*
58		* @var int
59		*/
60	1006	$lastAssignedId = count($options) + 1;
61
62		/**
63		* The option that was processed last time.
64		*/
65	1006	$lastOption = null;
66
67		/**
68		* The index of the option that was processed last time.
69		*
70		* @var int
71		*/
72	1006	$lastOptionId = 0;
73
74		/**
75		* Counts brackets.
76		*
77		* @var int
78		*/
79	1006	$brackets = 0;
80
81		/**
82		* The state of the parser.
83		*
84		* Below are the states of the parser.
85		*
86		* 0 ---------------------[ option ]----------------------> 1
87		*
88		* 1 -------------------[ = (optional) ]------------------> 2
89		*
90		* 2 ----------------------[ value ]----------------------> 0
91		*
92		* @var int
93		*/
94	1006	$state = 0;
95
96	1006	for (; $list->idx < $list->count; ++$list->idx) {
97		/**
98		* Token parsed at this moment.
99		*/
100	1006	$token = $list->tokens[$list->idx];
101
102		// End of statement.
103	1006	if ($token->type === Token::TYPE_DELIMITER) {
104	254	break;
105		}
106
107		// Skipping comments.
108	996	if ($token->type === Token::TYPE_COMMENT) {
109	24	continue;
110		}
111
112		// Skipping whitespace if not parsing value.
113	996	if (($token->type === Token::TYPE_WHITESPACE) && ($brackets === 0)) {
114	952	continue;
115		}
116
117	996	if ($lastOption === null) {
118	996	$upper = strtoupper($token->token);
119	996	if (! isset($options[$upper])) {
120		// There is no option to be processed.
121	956	break;
122		}
123
124	586	$lastOption = $options[$upper];
125	586	$lastOptionId = is_array($lastOption) ?
126	586	$lastOption[0] : $lastOption;
127	586	$state = 0;
128
129		// Checking for option conflicts.
130		// For example, in `SELECT` statements the keywords `ALL`
131		// and `DISTINCT` conflict and if used together, they
132		// produce an invalid query.
133		//
134		// Usually, tokens can be identified in the array by the
135		// option ID, but if conflicts occur, a generated option ID
136		// is used.
137		//
138		// The first pseudo duplicate ID is the maximum value of the
139		// real options (e.g. if there are 5 options, the first
140		// fake ID is 6).
141	586	if (isset($ret->options[$lastOptionId])) {
142	16	$parser->error(
143	16	sprintf(
144	16	Translator::gettext('This option conflicts with "%1$s".'),
145	16	is_array($ret->options[$lastOptionId])
146	10	? $ret->options[$lastOptionId]['name']
147	16	: $ret->options[$lastOptionId]
148	16	),
149	16	$token
150	16	);
151	16	$lastOptionId = $lastAssignedId++;
152		}
153		}
154
155	586	if ($state === 0) {
156	586	if (! is_array($lastOption)) {
157		// This is a just keyword option without any value.
158		// This is the beginning and the end of it.
159	532	$ret->options[$lastOptionId] = $token->value;
160	532	$lastOption = null;
161	532	$state = 0;
162	256	} elseif (($lastOption[1] === 'var') \|\| ($lastOption[1] === 'var=')) {
163		// This is a keyword that is followed by a value.
164		// This is only the beginning. The value is parsed in state
165		// 1 and 2. State 1 is used to skip the first equals sign
166		// and state 2 to parse the actual value.
167	190	$ret->options[$lastOptionId] = [
168		// @var string The name of the option.
169	190	'name' => $token->value,
170		// @var bool Whether it contains an equal sign.
171		// This is used by the builder to rebuild it.
172	190	'equals' => $lastOption[1] === 'var=',
173		// @var string Raw value.
174	190	'expr' => '',
175		// @var string Processed value.
176	190	'value' => '',
177	190	];
178	190	$state = 1;
179	130	} elseif ($lastOption[1] === 'expr' \|\| $lastOption[1] === 'expr=') {
180		// This is a keyword that is followed by an expression.
181		// The expression is used by the specialized parser.
182
183		// Skipping this option in order to parse the expression.
184	130	++$list->idx;
185	130	$ret->options[$lastOptionId] = [
186		// @var string The name of the option.
187	130	'name' => $token->value,
188		// @var bool Whether it contains an equal sign.
189		// This is used by the builder to rebuild it.
190	130	'equals' => $lastOption[1] === 'expr=',
191		// @var Expression The parsed expression.
192	130	'expr' => '',
193	130	];
194	586	$state = 1;
195		}
196	248	} elseif ($state === 1) {
197	248	$state = 2;
198	248	if ($token->token === '=') {
199	98	$ret->options[$lastOptionId]['equals'] = true;
200	98	continue;
201		}
202		}
203
204		// This is outside the `elseif` group above because the change might
205		// change this iteration.
206	586	if ($state !== 2) {
207	586	continue;
208		}
209
210	248	if ($lastOption[1] === 'expr' \|\| $lastOption[1] === 'expr=') {
211	130	$ret->options[$lastOptionId]['expr'] = Expression::parse(
212	130	$parser,
213	130	$list,
214	130	empty($lastOption[2]) ? [] : $lastOption[2]
215	130	);
216	130	if ($ret->options[$lastOptionId]['expr'] !== null) {
217	130	$ret->options[$lastOptionId]['value']
218	130	= $ret->options[$lastOptionId]['expr']->expr;
219		}
220
221	130	$lastOption = null;
222	130	$state = 0;
223		} else {
224	182	if ($token->token === '(') {
225	6	++$brackets;
226	182	} elseif ($token->token === ')') {
227	6	--$brackets;
228		}
229
230	182	$ret->options[$lastOptionId]['expr'] .= $token->token;
231
232		if (
233	182	! (($token->token === '(') && ($brackets === 1)
234	182	\|\| (($token->token === ')') && ($brackets === 0)))
235		) {
236		// First pair of brackets is being skipped.
237	182	$ret->options[$lastOptionId]['value'] .= $token->value;
238		}
239
240		// Checking if we finished parsing.
241	182	if ($brackets === 0) {
242	182	$lastOption = null;
243		}
244		}
245		}
246
247		/*
248		* We reached the end of statement without getting a value
249		* for an option for which a value was required
250		*/
251		if (
252	1006	$state === 1
		0 ignored issues – show introduced 2020-08-16 13:42 UTC by Report Bug Copy Issue Report The condition `$state === 1` is always `false`. Loading history...
253		&& $lastOption
254	1006	&& ($lastOption[1] === 'expr'
255	1006	\|\| $lastOption[1] === 'var'
256	1006	\|\| $lastOption[1] === 'var='
257	1006	\|\| $lastOption[1] === 'expr=')
258		) {
259	8	$parser->error(
260	8	sprintf(
261	8	'Value/Expression for the option %1$s was expected.',
262	8	$ret->options[$lastOptionId]['name']
263	8	),
264	8	$list->tokens[$list->idx - 1]
265	8	);
266		}
267
268	1006	if (empty($options['_UNSORTED'])) {
269	1006	ksort($ret->options);
270		}
271
272	1006	--$list->idx;
273
274	1006	return $ret;
275		}
276
277		/**
278		* @param OptionsArray $component the component to be built
279		* @param array<string, mixed> $options parameters for building
280		*/
281	192	public static function build($component, array $options = []): string
282		{
283	192	if (empty($component->options)) {
284	164	return '';
285		}
286
287	116	$options = [];
288	116	foreach ($component->options as $option) {
289	116	if (! is_array($option)) {
290	98	$options[] = $option;
291		} else {
292	68	$options[] = $option['name']
293	68	. (! empty($option['equals']) && $option['equals'] ? '=' : ' ')
294	68	. (! empty($option['expr']) ? $option['expr'] : $option['value']);
295		}
296		}
297
298	116	return implode(' ', $options);
299		}
300
301		/**
302		* Checks if it has the specified option and returns it value or true.
303		*
304		* @param string $key the key to be checked
305		* @param bool $getExpr Gets the expression instead of the value.
306		* The value is the processed form of the expression.
307		*
308		* @return mixed
309		*/
310	416	public function has($key, $getExpr = false)
311		{
312	416	foreach ($this->options as $option) {
313	390	if (is_array($option)) {
314	98	if (! strcasecmp($key, $option['name'])) {
315	98	return $getExpr ? $option['expr'] : $option['value'];
316		}
317	388	} elseif (! strcasecmp($key, $option)) {
318	370	return true;
319		}
320		}
321
322	392	return false;
323		}
324
325		/**
326		* Removes the option from the array.
327		*
328		* @param string $key the key to be removed
329		*
330		* @return bool whether the key was found and deleted or not
331		*/
332	10	public function remove($key)
333		{
334	10	foreach ($this->options as $idx => $option) {
335	10	if (is_array($option)) {
336	10	if (! strcasecmp($key, $option['name'])) {
337	10	unset($this->options[$idx]);
338
339	10	return true;
340		}
341	10	} elseif (! strcasecmp($key, $option)) {
342	10	unset($this->options[$idx]);
343
344	10	return true;
345		}
346		}
347
348	2	return false;
349		}
350
351		/**
352		* Merges the specified options with these ones. Values with same ID will be
353		* replaced.
354		*
355		* @param array<int, mixed>\|OptionsArray $options the options to be merged
356		*
357		* @return void
358		*/
359	22	public function merge($options)
360		{
361	22	if (is_array($options)) {
362	2	$this->options = array_merge_recursive($this->options, $options);
363	20	} elseif ($options instanceof self) {
		0 ignored issues – show introduced 2020-08-16 13:42 UTC by Report Bug Copy Issue Report `$options` is always a sub-type of `self`. Loading history...
364	20	$this->options = array_merge_recursive($this->options, $options->options);
365		}
366		}
367
368		/**
369		* Checks tf there are no options set.
370		*
371		* @return bool
372		*/
373	162	public function isEmpty()
374		{
375	162	return empty($this->options);
376		}
377
378	96	public function __toString(): string
379		{
380	96	return static::build($this);
381		}
382		}
383

phpmyadmin / sql-parser

Push — master ( 6c3f09...c54108 )

OptionsArray::__toString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like