Initial Commit

database/phpMyAdmin/vendor/phpmyadmin/sql-parser/src/Components/ArrayObj.php

@@ -0,0 +1,181 @@
+<?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 function implode;
+use function is_array;
+use function strlen;
+use function trim;
+
+/**
+ * Parses an array.
+ *
+ * @final
+ */
+class ArrayObj extends Component
+{
+    /**
+     * The array that contains the unprocessed value of each token.
+     *
+     * @var string[]
+     */
+    public $raw = [];
+
+    /**
+     * The array that contains the processed value of each token.
+     *
+     * @var string[]
+     */
+    public $values = [];
+
+    /**
+     * @param string[] $raw    the unprocessed values
+     * @param string[] $values the processed values
+     */
+    public function __construct(array $raw = [], array $values = [])
+    {
+        $this->raw = $raw;
+        $this->values = $values;
+    }
+
+    /**
+     * @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 ArrayObj|Component[]
+     */
+    public static function parse(Parser $parser, TokensList $list, array $options = [])
+    {
+        $ret = empty($options['type']) ? new static() : [];
+
+        /**
+         * The last raw expression.
+         *
+         * @var string
+         */
+        $lastRaw = '';
+
+        /**
+         * The last value.
+         *
+         * @var string
+         */
+        $lastValue = '';
+
+        /**
+         * Counts brackets.
+         *
+         * @var int
+         */
+        $brackets = 0;
+
+        /**
+         * Last separator (bracket or comma).
+         *
+         * @var bool
+         */
+        $isCommaLast = false;
+
+        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 whitespaces and comments.
+            if (($token->type === Token::TYPE_WHITESPACE) || ($token->type === Token::TYPE_COMMENT)) {
+                $lastRaw .= $token->token;
+                $lastValue = trim($lastValue) . ' ';
+                continue;
+            }
+
+            if (($brackets === 0) && (($token->type !== Token::TYPE_OPERATOR) || ($token->value !== '('))) {
+                $parser->error('An opening bracket was expected.', $token);
+                break;
+            }
+
+            if ($token->type === Token::TYPE_OPERATOR) {
+                if ($token->value === '(') {
+                    if (++$brackets === 1) { // 1 is the base level.
+                        continue;
+                    }
+                } elseif ($token->value === ')') {
+                    if (--$brackets === 0) { // Array ended.
+                        break;
+                    }
+                } elseif ($token->value === ',') {
+                    if ($brackets === 1) {
+                        $isCommaLast = true;
+                        if (empty($options['type'])) {
+                            $ret->raw[] = trim($lastRaw);
+                            $ret->values[] = trim($lastValue);
+                            $lastRaw = $lastValue = '';
+                        }
+                    }
+
+                    continue;
+                }
+            }
+
+            if (empty($options['type'])) {
+                $lastRaw .= $token->token;
+                $lastValue .= $token->value;
+            } else {
+                $ret[] = $options['type']::parse(
+                    $parser,
+                    $list,
+                    empty($options['typeOptions']) ? [] : $options['typeOptions']
+                );
+            }
+        }
+
+        // Handling last element.
+        //
+        // This is treated differently to treat the following cases:
+        //
+        //           => []
+        //      [,]  => ['', '']
+        //      []   => []
+        //      [a,] => ['a', '']
+        //      [a]  => ['a']
+        $lastRaw = trim($lastRaw);
+        if (empty($options['type']) && ((strlen($lastRaw) > 0) || ($isCommaLast))) {
+            $ret->raw[] = $lastRaw;
+            $ret->values[] = trim($lastValue);
+        }
+
+        return $ret;
+    }
+
+    /**
+     * @param ArrayObj|ArrayObj[]  $component the component to be built
+     * @param array<string, mixed> $options   parameters for building
+     *
+     * @return string
+     */
+    public static function build($component, array $options = [])
+    {
+        if (is_array($component)) {
+            return implode(', ', $component);
+        }
+
+        if (! empty($component->raw)) {
+            return '(' . implode(', ', $component->raw) . ')';
+        }
+
+        return '(' . implode(', ', $component->values) . ')';
+    }
+}