summaryrefslogtreecommitdiffstats
path: root/src/Fragments/OptionsFragment.php
blob: 00ac282c16df85a35a10c7645c41f15313b7e8fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<?php

/**
 * Parses a list of options.
 *
 * @package    SqlParser
 * @subpackage Fragments
 */
namespace SqlParser\Fragments;

use SqlParser\Fragment;
use SqlParser\Parser;
use SqlParser\Token;
use SqlParser\TokensList;

/**
 * Parses a list of options.
 *
 * @category   Fragments
 * @package    SqlParser
 * @subpackage Fragments
 * @author     Dan Ungureanu <udan1107@gmail.com>
 * @license    http://opensource.org/licenses/GPL-2.0 GNU Public License
 */
class OptionsFragment extends Fragment
{

    /**
     * Array of selected options.
     *
     * @var array
     */
    public $options = array();

    /**
     * Constructor.
     *
     * @param array $options The array of options. Options that have a value
     *                       must be an array with two keys 'name' and 'value'.
     */
    public function __construct(array $options = array())
    {
        $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      $options Parameters for parsing.
     *
     * @return OptionsFragment
     */
    public static function parse(Parser $parser, TokensList $list, array $options = array())
    {
        $ret = new OptionsFragment();

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

        /**
         * The option that was processed last time.
         * @var array
         */
        $lastOption = null;
        $lastOptionId = 0;

        $brackets = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             * @var Token
             */
            $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)) {
                continue;
            }

            if ($lastOption === null) {
                if (isset($options[strtoupper($token->value)])) {
                    $lastOption = $options[strtoupper($token->value)];
                    $lastOptionId = is_array($lastOption) ? $lastOption[0] : $lastOption;

                    // 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 psuedo 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('This option conflicts with \'' . $ret->options[$lastOptionId] . '\'.', $token);
                        $lastOptionId = $lastAssignedId++;
                    }
                } else {
                    // There is no option to be processed.
                    break;
                }
            }

            if (is_array($lastOption)) {
                if (empty($ret->options[$lastOptionId])) {
                    $ret->options[$lastOptionId] = array('name' => $token->value, 'value' => '');
                } else {
                    if ($token->value !== '=') {
                        if ($token->value === '(') {
                            ++$brackets;
                        } elseif ($token->value === ')') {
                            --$brackets;
                        } else {
                            $ret->options[$lastOptionId]['value'] .= $token->value;
                        }
                        if ($brackets === 0) {
                            $lastOption = null;
                        }
                    }
                }
            } else {
                $ret->options[$lastOptionId] = $token->value;
                $lastOption = null;
            }
        }

        ksort($ret->options);

        --$list->idx;
        return $ret;
    }

    /**
     * @param OptionsFragment $fragment The fragment to be built.
     *
     * @return string
     */
    public static function build($fragment)
    {
        $options = array();
        foreach ($fragment->options as $option) {
            if (is_array($option)) {
                $options[] = $option['name'] . '=' . $option['value'];
            } else {
                $options[] = $option;
            }
        }
        return implode(' ', $options);
    }

    /**
     * Checks if it has the specified option and returns it value or true.
     *
     * @param string $key The key to be checked.
     *
     * @return mixed
     */
    public function has($key)
    {
        foreach ($this->options as $option) {
            if ((is_array($option)) && ($key === $option['name'])) {
                return $option['value'];
            } elseif ($key === $option) {
                return true;
            }
        }
        return false;
    }

    /**
     * Merges the specified options with these ones. Values with same ID will be
     * replaced.
     *
     * @param array|OptionsFragment $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 OptionsFragment) {
            $this->options = array_merge_recursive($this->options, $options->options);
        }
    }
}