classOperatorScanner

packages/sql-parser/src/PostgreSql/Lexer/OperatorScanner.php:21

final class OperatorScanner

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Reads PostgreSQL's operators and punctuation.

A user-defined operator is the longest run of operator characters that does not start a comment. A run that ends in + or - gives those up unless it also holds a character that only user-defined operators use, so that a<-1 reads as a < -1. A single character that stands for itself and the few two-character comparisons have terminals of their own.

Constants§

public const SELF = ',()[].;:+-*/%^<>='

source §

Characters that are tokens of their own.

public const OPERATOR = '~!@#^&|`?+-*/%<>='

source §

Characters a user-defined operator may hold.

public const KEEPS_SIGN = '~!@#^&|`?%'

source §

Characters whose presence lets an operator keep a trailing + or -.

public const FIXED = ['::' => 'TYPECAST', '..' => 'DOT_DOT', ':=' => 'COLON_EQUALS', '=>' => 'EQUALS…

source §

Terminals of the multi-character punctuation that is not an operator run.

Methods§

public function scan(Scan $scan): Lexeme

source §

Reads the operator or punctuation at the cursor.

Parameters

$scan Scan The tokenization in progress

Returns

Lexeme The lexeme

Throws

LexicalException When the character starts no token at all

Test cases 3

Called from 1

method-call SqlParser\PostgreSql\Lexer\PostgreSqlLexer::scan() packages/sql-parser/src/PostgreSql/Lexer/PostgreSqlLexer.php:59

Calls 8

method-call OperatorScanner::operatorRun() line 56
function-call strlen line 57
function-call substr line 58
class-const OperatorScanner::FIXED() line 59
method-call Scan::lexeme() line 62
function-call str_contains line 65
class-const OperatorScanner::SELF() line 65
static-call LexicalException::unexpectedCharacter() line 71

public function operatorRun(string $source, int $offset): string|null

source §

Answers the operator run at an offset, trimmed as the scanner trims it.

Parameters

`$source`	`string`	The SQL text
`$offset`	`int`	Where the run starts

Returns

string|null The run, or null when no operator character is there

Test cases 1

OperatorScannerTest::testOperatorRun calls

Called from 1

method-call SqlParser\PostgreSql\Lexer\OperatorScanner::scan() packages/sql-parser/src/PostgreSql/Lexer/OperatorScanner.php:56

Calls 6

function-call str_contains line 96
class-const OperatorScanner::OPERATOR() line 96
function-call substr line 97
function-call strpbrk line 107
class-const OperatorScanner::KEEPS_SIGN() line 107
function-call rtrim line 108

Test cases 6§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 4

Other tests reaching this symbol 2

PostgreSqlLexerTest calls
PostgreSqlParserTest calls

Relations§

Instantiated in 1

new SqlParser\PostgreSql\Lexer\PostgreSqlLexer::__construct() packages/sql-parser/src/PostgreSql/Lexer/PostgreSqlLexer.php:33

Method calls 1

method-call SqlParser\PostgreSql\Lexer\PostgreSqlLexer::scan() packages/sql-parser/src/PostgreSql/Lexer/PostgreSqlLexer.php:59

Type declarations 1

type SqlParser\PostgreSql\Lexer\PostgreSqlLexer packages/sql-parser/src/PostgreSql/Lexer/PostgreSqlLexer.php:33