IntoKeyword::build() - Code Metrics - Inspection of "Fix #105: Fix parsing of FIELDS and LINES options..." - phpmyadmin/sql-parser - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#107)

by Deven

created 2016-12-21 17:12 UTC

IntoKeyword::build() C

↳ Parent: IntoKeyword

Complexity

Conditions	7
Paths	9

Size

Total Lines	25
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
cc	7
eloc	17
nc	9
nop	2
dl	0
loc	25
ccs	0
cts	0
cp	0
crap	56
rs	6.7272
c	0
b	0
f	0

<?php

/**
 * `INTO` keyword parser.
 *
 * @package    SqlParser
 * @subpackage Components
 */
namespace SqlParser\Components;

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

/**
 * `INTO` keyword parser.
 *
 * @category   Keywords
 * @package    SqlParser
 * @subpackage Components
 * @license    https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
 */
class IntoKeyword extends Component
{

    /**
     * FIELDS/COLUMNS Options for `SELECT...INTO` statements.
     *
     * @var array
     */
    public static $FIELDS_OPTIONS = array(

        'TERMINATED BY'                 => array(1, 'expr'),
        'OPTIONALLY'                    => 2,
        'ENCLOSED BY'                   => array(3, 'expr'),
        'ESCAPED BY'                    => array(4, 'expr'),
    );

    /**
     * LINES Options for `SELECT...INTO` statements.
     *
     * @var array
     */
    public static $LINES_OPTIONS = array(

        'STARTING BY'                 => array(1, 'expr'),
        'TERMINATED BY'               => array(2, 'expr'),
    );

    /**
     * Type of target (OUTFILE or SYMBOL).
     *
     * @var string
     */
    public $type;

    /**
     * The destination, which can be a table or a file.
     *
     * @var string|Expression
     */
    public $dest;

    /**
     * The name of the columns.
     *
     * @var array
     */
    public $columns;

    /**
     * The values to be selected into (SELECT .. INTO @var1)
     *
     * @var ExpressionArray
     */
    public $values;

    /**
     * Options for FIELDS/COLUMNS keyword
     *
     * @var OptionsArray
     * @see static::$FIELDS_OPTIONS
     */
    public $fields_options;

    /**
     * Whether to use `FIELDS` or `COLUMNS` while building
     *
     * @var boolean
     */
    public $fields_keyword;

    /**
     * Options for OPTIONS keyword
     *
     * @var OptionsArray
     * @see static::$LINES_OPTIONS
     */
    public $lines_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 IntoKeyword
     */
    public static function parse(Parser $parser, TokensList $list, array $options = array())
    {
        $ret = new IntoKeyword();

        /**
         * The state of the parser.
         *
         * Below are the states of the parser.
         *
         *      0 -----------------------[ name ]----------------------> 1
         *      0 ---------------------[ OUTFILE ]---------------------> 2
         *
         *      1 ------------------------[ ( ]------------------------> (END)
         *
         *      2 ---------------------[ filename ]--------------------> 1
         *
         * @var int $state
         */
        $state = 0;

        for (; $list->idx < $list->count; ++$list->idx) {
            /**
             * Token parsed at this moment.
             *
             * @var Token $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 (($token->type === Token::TYPE_KEYWORD) && ($token->flags & Token::FLAG_KEYWORD_RESERVED)) {
                if (($state === 0) && ($token->value === 'OUTFILE')) {
                    $ret->type = 'OUTFILE';
                    $state = 2;
                    continue;
                }

                // No other keyword is expected except for $state = 4, which expects `LINES`
                if ($state !== 4) {
                    break;
                }
            }

            if ($state === 0) {
                if ((isset($options['fromInsert'])
                    && $options['fromInsert'])
                    || (isset($options['fromReplace'])
                    && $options['fromReplace'])
                ) {
                    $ret->dest = Expression::parse(
                        $parser,
                        $list,
                        array(
                            'parseField' => 'table',
                            'breakOnAlias' => true,
                        )
                    );
                } else {
                    $ret->values = ExpressionArray::parse($parser, $list);

                }
                $state = 1;
            } elseif ($state === 1) {
                if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
                    $ret->columns = ArrayObj::parse($parser, $list)->values;
                    ++$list->idx;
                }
                break;
            } elseif ($state === 2) {
                $ret->dest = $token->value;

                $state = 3;
            } elseif ($state == 3) {
                $ret->_parseFileOptions($parser, $list, $token->value);
                $state = 4;
            } elseif ($state == 4) {
                if ($token->type === Token::TYPE_KEYWORD && $token->value !== 'LINES') {
                    break;
                }

                $ret->_parseFileOptions($parser, $list, $token->value);
                $state = 5;
            }
        }

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

    private function _parseFileOptions(Parser $parser, TokensList $list, $keyword='FIELDS') {
        ++$list->idx;

        if ($keyword === 'FIELDS' || $keyword === 'COLUMNS') {
            // parse field options
            $this->fields_options = OptionsArray::parse(
                $parser,
                $list,
                static::$FIELDS_OPTIONS
            );

            if ($keyword === 'FIELDS') {
                $this->fields_keyword = true;
            } else {
                $this->fields_keyword = false;
            }
        } else {
            // parse line options
            $this->lines_options = OptionsArray::parse(
                $parser,
                $list,
                static::$LINES_OPTIONS
            );
        }
    }

    /**
     * @param IntoKeyword $component The component to be built.
     * @param array       $options   Parameters for building.
     *
     * @return string
     */
    public static function build($component, array $options = array())
    {
        if ($component->dest instanceof Expression) {
            $columns = !empty($component->columns) ?
                '(`' . implode('`, `', $component->columns) . '`)' : '';
            return $component->dest . $columns;
        } elseif (isset($component->values)) {
            return ExpressionArray::build($component->values);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } else {
            $ret = 'OUTFILE "' . $component->dest . '"';

            $fields_options_str = OptionsArray::build($component->fields_options);
            if (trim($fields_options_str) !== '') {
                $ret .= ($component->fields_keyword) ? ' FIELDS' : ' COLUMNS';
                $ret .= ' ' . $fields_options_str;
            }

            $lines_options_str = OptionsArray::build($component->lines_options, array('expr' => true));
            if (trim($lines_options_str) !== '') {
                $ret .= ' LINES ' . $lines_options_str;
            }

            return $ret;
        }
    }
}

1		<?php
2
3		/**
4		* `INTO` keyword parser.
5		*
6		* @package SqlParser
7		* @subpackage Components
8		*/
9		namespace SqlParser\Components;
10
11		use SqlParser\Component;
12		use SqlParser\Parser;
13		use SqlParser\Token;
14		use SqlParser\TokensList;
15
16		/**
17		* `INTO` keyword parser.
18		*
19		* @category Keywords
20		* @package SqlParser
21		* @subpackage Components
22		* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
23		*/
24		class IntoKeyword extends Component
25		{
26
27		/**
28		* FIELDS/COLUMNS Options for `SELECT...INTO` statements.
29		*
30		* @var array
31		*/
32		public static $FIELDS_OPTIONS = array(
33
34		'TERMINATED BY' => array(1, 'expr'),
35		'OPTIONALLY' => 2,
36		'ENCLOSED BY' => array(3, 'expr'),
37		'ESCAPED BY' => array(4, 'expr'),
38		);
39
40		/**
41		* LINES Options for `SELECT...INTO` statements.
42		*
43		* @var array
44		*/
45		public static $LINES_OPTIONS = array(
46
47		'STARTING BY' => array(1, 'expr'),
48		'TERMINATED BY' => array(2, 'expr'),
49		);
50
51		/**
52		* Type of target (OUTFILE or SYMBOL).
53		*
54		* @var string
55		*/
56	15	public $type;
57
58	15	/**
59		* The destination, which can be a table or a file.
60		*
61		* @var string\|Expression
62		*/
63		public $dest;
64
65		/**
66		* The name of the columns.
67		*
68		* @var array
69		*/
70		public $columns;
71
72		/**
73		* The values to be selected into (SELECT .. INTO @var1)
74	15	*
75		* @var ExpressionArray
76	15	*/
77		public $values;
78
79		/**
80		* Options for FIELDS/COLUMNS keyword
81		*
82	15	* @var OptionsArray
83		* @see static::$FIELDS_OPTIONS
84		*/
85	15	public $fields_options;
86	1
87		/**
88		* Whether to use `FIELDS` or `COLUMNS` while building
89		*
90	15	* @var boolean
91	13	*/
92		public $fields_keyword;
93
94	15	/**
95	9	* Options for OPTIONS keyword
96	6	*
97	6	* @var OptionsArray
98	6	* @see static::$LINES_OPTIONS
99		*/
100		public $lines_options;
101
102	3	/**
103		* @param Parser $parser The parser that serves as context.
104		* @param TokensList $list The list of tokens that are being parsed.
105	14	* @param array $options Parameters for parsing.
106	9	*
107	9	* @return IntoKeyword
108	9	*/
109		public static function parse(Parser $parser, TokensList $list, array $options = array())
110	9	{
111	9	$ret = new IntoKeyword();
112
113	9	/**
114	9	* The state of the parser.
115	14	*
116	6	* Below are the states of the parser.
117	6	*
118	6	* 0 -----------------------[ name ]----------------------> 1
119	6	* 0 ---------------------[ OUTFILE ]---------------------> 2
120	6	*
121	5	* 1 ------------------------[ ( ]------------------------> (END)
122	5	*
123	5	* 2 ---------------------[ filename ]--------------------> 1
124	5	*
125		* @var int $state
126	9	*/
127		$state = 0;
128	15
129	15	for (; $list->idx < $list->count; ++$list->idx) {
130		/**
131		* Token parsed at this moment.
132		*
133		* @var Token $token
134		*/
135		$token = $list->tokens[$list->idx];
136
137		// End of statement.
138	3	if ($token->type === Token::TYPE_DELIMITER) {
139		break;
140	3	}
141	2
142	2	// Skipping whitespaces and comments.
143	2	if (($token->type === Token::TYPE_WHITESPACE) \|\| ($token->type === Token::TYPE_COMMENT)) {
144		continue;
145	1	}
146
147		if (($token->type === Token::TYPE_KEYWORD) && ($token->flags & Token::FLAG_KEYWORD_RESERVED)) {
148		if (($state === 0) && ($token->value === 'OUTFILE')) {
149		$ret->type = 'OUTFILE';
150		$state = 2;
151		continue;
152		}
153
154		// No other keyword is expected except for $state = 4, which expects `LINES`
155		if ($state !== 4) {
156		break;
157		}
158		}
159
160		if ($state === 0) {
161		if ((isset($options['fromInsert'])
162		&& $options['fromInsert'])
163		\|\| (isset($options['fromReplace'])
164		&& $options['fromReplace'])
165		) {
166		$ret->dest = Expression::parse(
167		$parser,
168		$list,
169		array(
170		'parseField' => 'table',
171		'breakOnAlias' => true,
172		)
173		);
174		} else {
175		$ret->values = ExpressionArray::parse($parser, $list);
		0 ignored issues – show Documentation Bug introduced 2016-09-28 08:00 UTC by Report Bug Copy Issue Report It seems like `\SqlParser\Components\Ex...::parse($parser, $list)` of type `array<integer,object<Sql...Components\Expression>>` is incompatible with the declared type `object<SqlParser\Components\ExpressionArray>` of property `$values`. 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...
176		}
177		$state = 1;
178		} elseif ($state === 1) {
179		if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
180		$ret->columns = ArrayObj::parse($parser, $list)->values;
181		++$list->idx;
182		}
183		break;
184		} elseif ($state === 2) {
185		$ret->dest = $token->value;
186
187		$state = 3;
188		} elseif ($state == 3) {
189		$ret->_parseFileOptions($parser, $list, $token->value);
190		$state = 4;
191		} elseif ($state == 4) {
192		if ($token->type === Token::TYPE_KEYWORD && $token->value !== 'LINES') {
193		break;
194		}
195
196		$ret->_parseFileOptions($parser, $list, $token->value);
197		$state = 5;
198		}
199		}
200
201		--$list->idx;
202		return $ret;
203		}
204
205		private function _parseFileOptions(Parser $parser, TokensList $list, $keyword='FIELDS') {
206		++$list->idx;
207
208		if ($keyword === 'FIELDS' \|\| $keyword === 'COLUMNS') {
209		// parse field options
210		$this->fields_options = OptionsArray::parse(
211		$parser,
212		$list,
213		static::$FIELDS_OPTIONS
214		);
215
216		if ($keyword === 'FIELDS') {
217		$this->fields_keyword = true;
218		} else {
219		$this->fields_keyword = false;
220		}
221		} else {
222		// parse line options
223		$this->lines_options = OptionsArray::parse(
224		$parser,
225		$list,
226		static::$LINES_OPTIONS
227		);
228		}
229		}
230
231		/**
232		* @param IntoKeyword $component The component to be built.
233		* @param array $options Parameters for building.
234		*
235		* @return string
236		*/
237		public static function build($component, array $options = array())
238		{
239		if ($component->dest instanceof Expression) {
240		$columns = !empty($component->columns) ?
241		'(`' . implode('`, `', $component->columns) . '`)' : '';
242		return $component->dest . $columns;
243		} elseif (isset($component->values)) {
244		return ExpressionArray::build($component->values);
		0 ignored issues – show Documentation introduced 2016-09-28 08:00 UTC by Report Bug Copy Issue Report `$component->values` is of type `object<SqlParser\Components\ExpressionArray>`, but the function expects a `array<integer,object<Sql...Components\Expression>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
245		} else {
246		$ret = 'OUTFILE "' . $component->dest . '"';
247
248		$fields_options_str = OptionsArray::build($component->fields_options);
249		if (trim($fields_options_str) !== '') {
250		$ret .= ($component->fields_keyword) ? ' FIELDS' : ' COLUMNS';
251		$ret .= ' ' . $fields_options_str;
252		}
253
254		$lines_options_str = OptionsArray::build($component->lines_options, array('expr' => true));
255		if (trim($lines_options_str) !== '') {
256		$ret .= ' LINES ' . $lines_options_str;
257		}
258
259		return $ret;
260		}
261		}
262		}

phpmyadmin / sql-parser

Pull Request — master (#107)

IntoKeyword::build() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like