Yiisoft\Db\Sqlite\SqlTokenizer

Complexity

Total Complexity

17

Size/Duplication

Total Lines	307
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	isOperator()	0	30	1
A	isStringLiteral()	0	19	4
A	isIdentifier()	0	26	6
B	isKeyword()	0	138	2
A	isWhitespace()	0	5	1
A	isComment()	0	13	3

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Sqlite;

use function mb_strtoupper;
use function strtr;

/**
 * Splits SQLite queries into individual SQL tokens.
 *
 * It's used to obtain `CHECK` constraint information from a `CREATE TABLE` SQL code.
 *
 * @link https://www.sqlite.org/draft/tokenreq.html
 * @link https://sqlite.org/lang.html
 */
final class SqlTokenizer extends AbstractTokenizer
{
    /**
     * Returns whether there's a space at the current offset.
     *
     * If this method returns `true`, it has to set the `$length` parameter to the length of the matched string.
     *
     * @param int $length The length of the matched string.
     *
     * @return bool Whether there's a space at the current offset.
     */
    protected function isWhitespace(int &$length): bool
    {
        $whitespaces = ["\f" => true, "\n" => true, "\r" => true, "\t" => true, ' ' => true];
        $length = 1;
        return isset($whitespaces[$this->substring($length)]);
    }

    /**
     * Returns whether there's a commentary at the current offset.
     *
     * If these methods return `true`, it has to set the `$length` parameter to the length of the matched string.
     *
     * @param int $length The length of the matched string.
     *
     * @return bool Whether there's a commentary at the current offset.
     */
    protected function isComment(int &$length): bool
    {
        $comments = ['--' => true, '/*' => true];
        $length = 2;

        if (!isset($comments[$this->substring($length)])) {
            return false;
        }

        $char = $this->substring($length) === '--' ? "\n" : '*/';
        $length = $this->indexAfter($char) - $this->offset;

        return true;
    }

    /**
     * Returns whether there's an operator at the current offset.
     *
     * If these methods return `true`, it has to set the `$length` parameter to the length of the matched string.
     *
     * It may also set `$content` to a string that will be used as a token content.
     *
     * @param int $length The length of the matched string.
     * @param string|null $content Optional content instead of the matched string.
     *
     * @return bool Whether there's an operator at the current offset.
     */
    protected function isOperator(int &$length, string|null &$content): bool
    {
        $operators = [
            '!=',
            '%',
            '&',
            '(',
            ')',
            '*',
            '+',
            ',',
            '-',
            '.',
            '/',
            ';',
            '<',
            '<<',
            '<=',
            '<>',
            '=',
            '==',
            '>',
            '>=',
            '>>',
            '|',
            '||',
            '~',
        ];

        return $this->startsWithAnyLongest($operators, true, $length);
    }

    /**
     * Returns whether there's an identifier at the current offset.
     *
     * If this method returns `true`, it has to set the `$length` parameter to the length of the matched string.
     *
     * It may also set `$content` to a string that will be used as a token content.
     *
     * @param int $length The length of the matched string.
     * @param string|null $content Optional content instead of the matched string.
     *
     * @return bool Whether there's an identifier at the current offset.
     */
    protected function isIdentifier(int &$length, string|null &$content): bool
    {
        $identifierDelimiters = ['"' => '"', '[' => ']', '`' => '`'];

        if (!isset($identifierDelimiters[$this->substring(1)])) {
            return false;
        }

        $delimiter = $identifierDelimiters[$this->substring(1)];
        $offset = $this->offset;

        while (true) {
            $offset = $this->indexAfter($delimiter, $offset + 1);
            if ($delimiter === ']' || $this->substring(1, true, $offset) !== $delimiter) {
                break;
            }
        }

        $length = $offset - $this->offset;
        $content = $this->substring($length - 2, true, $this->offset + 1);

        if ($delimiter !== ']') {
            $content = strtr($content, ["$delimiter$delimiter" => $delimiter]);
        }

        return true;
    }

    /**
     * Returns whether there's a string literal at the current offset.
     *
     * If this method returns `true`, it has to set the `$length` parameter to the length of the matched string.
     *
     * It may also set `$content` to a string that will be used as a token content.
     *
     * @param int $length The length of the matched string.
     * @param string|null $content Optional content instead of the matched string.
     *
     * @return bool Whether there's a string literal at the current offset.
     */
    protected function isStringLiteral(int &$length, string|null &$content): bool
    {
        if ($this->substring(1) !== "'") {
            return false;
        }

        $offset = $this->offset;

        while (true) {
            $offset = $this->indexAfter("'", $offset + 1);
            if ($this->substring(1, true, $offset) !== "'") {
                break;
            }
        }

        $length = $offset - $this->offset;
        $content = strtr($this->substring($length - 2, true, $this->offset + 1), ["''" => "'"]);

        return true;
    }

    /**
     * Returns whether the given string is a keyword.
     *
     * The method may set `$content` to a string that will be used as a token content.
     *
     * @param string $string The string to match.
     * @param string|null $content Optional content instead of the matched string.
     *
     * @return bool Whether the given string is a keyword.
     */
    protected function isKeyword(string $string, string|null &$content): bool
    {
        $keywords = [
            'ABORT' => true,
            'ACTION' => true,
            'ADD' => true,
            'AFTER' => true,
            'ALL' => true,
            'ALTER' => true,
            'ANALYZE' => true,
            'AND' => true,
            'AS' => true,
            'ASC' => true,
            'ATTACH' => true,
            'AUTOINCREMENT' => true,
            'BEFORE' => true,
            'BEGIN' => true,
            'BETWEEN' => true,
            'BY' => true,
            'CASCADE' => true,
            'CASE' => true,
            'CAST' => true,
            'CHECK' => true,
            'COLLATE' => true,
            'COLUMN' => true,
            'COMMIT' => true,
            'CONFLICT' => true,
            'CONSTRAINT' => true,
            'CREATE' => true,
            'CROSS' => true,
            'CURRENT_DATE' => true,
            'CURRENT_TIME' => true,
            'CURRENT_TIMESTAMP' => true,
            'DATABASE' => true,
            'DEFAULT' => true,
            'DEFERRABLE' => true,
            'DEFERRED' => true,
            'DELETE' => true,
            'DESC' => true,
            'DETACH' => true,
            'DISTINCT' => true,
            'DROP' => true,
            'EACH' => true,
            'ELSE' => true,
            'END' => true,
            'ESCAPE' => true,
            'EXCEPT' => true,
            'EXCLUSIVE' => true,
            'EXISTS' => true,
            'EXPLAIN' => true,
            'FAIL' => true,
            'FOR' => true,
            'FOREIGN' => true,
            'FROM' => true,
            'FULL' => true,
            'GLOB' => true,
            'GROUP' => true,
            'HAVING' => true,
            'IF' => true,
            'IGNORE' => true,
            'IMMEDIATE' => true,
            'IN' => true,
            'INDEX' => true,
            'INDEXED' => true,
            'INITIALLY' => true,
            'INNER' => true,
            'INSERT' => true,
            'INSTEAD' => true,
            'INTERSECT' => true,
            'INTO' => true,
            'IS' => true,
            'ISNULL' => true,
            'JOIN' => true,
            'KEY' => true,
            'LEFT' => true,
            'LIKE' => true,
            'LIMIT' => true,
            'MATCH' => true,
            'NATURAL' => true,
            'NO' => true,
            'NOT' => true,
            'NOTNULL' => true,
            'NULL' => true,
            'OF' => true,
            'OFFSET' => true,
            'ON' => true,
            'OR' => true,
            'ORDER' => true,
            'OUTER' => true,
            'PLAN' => true,
            'PRAGMA' => true,
            'PRIMARY' => true,
            'QUERY' => true,
            'RAISE' => true,
            'RECURSIVE' => true,
            'REFERENCES' => true,
            'REGEXP' => true,
            'REINDEX' => true,
            'RELEASE' => true,
            'RENAME' => true,
            'REPLACE' => true,
            'RESTRICT' => true,
            'RIGHT' => true,
            'ROLLBACK' => true,
            'ROW' => true,
            'SAVEPOINT' => true,
            'SELECT' => true,
            'SET' => true,
            'TABLE' => true,
            'TEMP' => true,
            'TEMPORARY' => true,
            'THEN' => true,
            'TO' => true,
            'TRANSACTION' => true,
            'TRIGGER' => true,
            'UNION' => true,
            'UNIQUE' => true,
            'UPDATE' => true,
            'USING' => true,
            'VACUUM' => true,
            'VALUES' => true,
            'VIEW' => true,
            'VIRTUAL' => true,
            'WHEN' => true,
            'WHERE' => true,
            'WITH' => true,
            'WITHOUT' => true,
        ];

        $string = mb_strtoupper($string, 'UTF-8');

        if (!isset($keywords[$string])) {
            return false;
        }

        $content = $string;

        return true;
    }
}