TYPO3 12.4 API: Parser

Parser

An LL(*) recursive-descent parser for MySQL CREATE TABLE statements.

Parses a CREATE TABLE statement, reports any errors in it, and generates an AST.

Properties

$lexer : Lexer
$statement : string

Methods

__construct() : mixed: Creates a new statement parser object.
createStatement() : AbstractCreateStatement: CreateStatement ::= CREATE [TEMPORARY] TABLE Abstraction to allow for support of other schema objects like views in the future.
free() : void: Frees this parser, enabling it to be reused.
getAST() : AbstractCreateStatement: Parses and builds AST for the given Query.
getLexer() : Lexer: Gets the lexer used by the parser.
indexName() : Identifier: Return the name of an index. No name has been supplied if the next token is USING which defines the index type.
indexOptions() : array<string|int, mixed>: IndexOptions ::= KEY_BLOCK_SIZE [=] value | index_type | WITH PARSER parser_name | COMMENT 'string'
indexType() : string: IndexType ::= USING { BTREE | HASH }
match() : mixed: Attempts to match the given token with the current lookahead token.
parse() : array<string|int, Table>: Parses a statement string.
queryLanguage() : AbstractCreateStatement: queryLanguage ::= CreateTableStatement
semanticalError() : void: Generates a new semantical error.
syntaxError() : void: Generates a new syntax error.
characterDataTypeOptions() : array<string|int, mixed>: Parse common options for numeric datatypes
columnDataType() : AbstractDataType: DataType ::= BIT[(length)] | TINYINT[(length)] [UNSIGNED] [ZEROFILL] | SMALLINT[(length)] [UNSIGNED] [ZEROFILL] | MEDIUMINT[(length)] [UNSIGNED] [ZEROFILL] | INT[(length)] [UNSIGNED] [ZEROFILL] | INTEGER[(length)] [UNSIGNED] [ZEROFILL] | BIGINT[(length)] [UNSIGNED] [ZEROFILL] | REAL[(length,decimals)] [UNSIGNED] [ZEROFILL] | DOUBLE[(length,decimals)] [UNSIGNED] [ZEROFILL] | FLOAT[(length,decimals)] [UNSIGNED] [ZEROFILL] | DECIMAL[(length[,decimals])] [UNSIGNED] [ZEROFILL] | NUMERIC[(length[,decimals])] [UNSIGNED] [ZEROFILL] | DATE | TIME[(fsp)] | TIMESTAMP[(fsp)] | DATETIME[(fsp)] | YEAR | CHAR[(length)] [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | VARCHAR(length) [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | BINARY[(length)] | VARBINARY(length) | TINYBLOB | BLOB | MEDIUMBLOB | LONGBLOB | TINYTEXT [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | TEXT [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | MEDIUMTEXT [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | LONGTEXT [BINARY] [CHARACTER SET charset_name] [COLLATE collation_name] | ENUM(value1,value2,value3,...) [CHARACTER SET charset_name] [COLLATE collation_name] | SET(value1,value2,value3,...) [CHARACTER SET charset_name] [COLLATE collation_name] | JSON
columnDefaultValue() : mixed: DefaultValue::= DEFAULT default_value
createColumnDefinitionItem() : CreateColumnDefinitionItem: CreateColumnDefinitionItem ::= col_name column_definition
createDefinition() : CreateDefinition: Parses the table field/index definition
createDefinitionItem() : AbstractCreateDefinitionItem: Parse the definition of a single column or index
createForeignKeyDefinitionItem() : CreateForeignKeyDefinitionItem: Parses a foreign key definition item contained in the create definition
createIndexDefinitionItem() : CreateIndexDefinitionItem: Parses an index definition item contained in the create definition
createTableClause() : CreateTableClause: CreateTableClause ::= CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name
createTableStatement() : CreateTableStatement: CreateTableStatement ::= CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name (create_definition,...) [tbl_options]
dataTypeLength() : int: Determine length parameter of a column field definition, i.E. INT(11) or VARCHAR(255)
enumerationDataTypeOptions() : array<string|int, mixed>: Parse shared options for enumeration datatypes (ENUM and SET)
fractionalSecondsPart() : int: Determine the fractional seconds part support for TIME, DATETIME and TIMESTAMP columns
indexColumnName() : IndexColumnName: IndexColumnName ::= col_name [(length)] [ASC | DESC]
numericDataTypeOptions() : array<string|int, mixed>: Parse common options for numeric datatypes
peekBeyondClosingParenthesis() : Token: Peeks beyond the matched closing parenthesis and returns the first token after that one.
referenceDefinition() : ReferenceDefinition: ReferenceDefinition ::= REFERENCES tbl_name (index_col_name,...) [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE] [ON DELETE reference_option] [ON UPDATE reference_option]
referenceOption() : string: ReferenceOption ::= RESTRICT | CASCADE | SET NULL | NO ACTION
schemaObjectName() : Identifier: Certain objects within MySQL, including database, table, index, column, alias, view, stored procedure, partition, tablespace, and other object names are known as identifiers.
tableOptions() : array<string|int, mixed>: Parse MySQL table options
tableOptionValue() : mixed: Return the value of an option, skipping the optional equal sign.
valueList() : array<string|int, mixed>: Return all defined values for an enumeration datatype (ENUM, SET)
valueListItem() : string: Return a value list item for an enumeration set

$lexer


    protected
        Lexer
    $lexer

$statement


    protected
        string
    $statement
     = ''

__construct()

Creates a new statement parser object.


    public
                    __construct(string $statement) : mixed

Parameters

$statement : string: The statement to parse.

createStatement()

CreateStatement ::= CREATE [TEMPORARY] TABLE Abstraction to allow for support of other schema objects like views in the future.


    public
                    createStatement() : AbstractCreateStatement

Return values

AbstractCreateStatement

free()

Frees this parser, enabling it to be reused.


    public
                    free([bool $deep = false ][, int $position = 0 ]) : void

Parameters

$deep : bool = false: Whether to clean peek and reset errors.
$position : int = 0: Position to reset.

getAST()

Parses and builds AST for the given Query.


    public
                    getAST() : AbstractCreateStatement

Return values

AbstractCreateStatement

getLexer()

Gets the lexer used by the parser.


    public
                    getLexer() : Lexer

Return values

Lexer

indexName()

Return the name of an index. No name has been supplied if the next token is USING which defines the index type.


    public
                    indexName() : Identifier

Return values

Identifier

indexOptions()

IndexOptions ::= KEY_BLOCK_SIZE [=] value | index_type | WITH PARSER parser_name | COMMENT 'string'


    public
                    indexOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

indexType()

IndexType ::= USING { BTREE | HASH }


    public
                    indexType() : string

Return values

string

match()

Attempts to match the given token with the current lookahead token.


    public
                    match(int $token) : mixed

If they match, updates the lookahead token; otherwise raises a syntax error.

Parameters

$token : int: The token type.

parse()

Parses a statement string.


    public
                    parse() : array<string|int, Table>

Return values

array<string|int, Table>

queryLanguage()

queryLanguage ::= CreateTableStatement


    public
                    queryLanguage() : AbstractCreateStatement

Return values

AbstractCreateStatement

semanticalError()

Generates a new semantical error.


    public
                    semanticalError([string $message = '' ][, Token|null $token = null ]) : void

Parameters

$message : string = '': Optional message.
$token : Token|null = null: Optional token.

syntaxError()

Generates a new syntax error.


    public
                    syntaxError([string $expected = '' ][, Token|null $token = null ]) : void

Parameters

$expected : string = '': Expected string.
$token : Token|null = null: Got token.

characterDataTypeOptions()

Parse common options for numeric datatypes


    protected
                    characterDataTypeOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

columnDataType()


    protected
                    columnDataType() : AbstractDataType

Return values

AbstractDataType

columnDefaultValue()

DefaultValue::= DEFAULT default_value


    protected
                    columnDefaultValue() : mixed

createColumnDefinitionItem()

CreateColumnDefinitionItem ::= col_name column_definition


    protected
                    createColumnDefinitionItem() : CreateColumnDefinitionItem

column_definition: data_type [NOT NULL | NULL] [DEFAULT default_value] [AUTO_INCREMENT] [UNIQUE [KEY] | [PRIMARY] KEY] [COMMENT 'string'] [COLUMN_FORMAT {FIXED|DYNAMIC|DEFAULT}] [STORAGE {DISK|MEMORY|DEFAULT}] [reference_definition]

Return values

CreateColumnDefinitionItem

createDefinition()

Parses the table field/index definition


    protected
                    createDefinition() : CreateDefinition

createDefinition ::= ( col_name column_definition | [CONSTRAINT [symbol]] PRIMARY KEY [index_type] (index_col_name,...) [index_option] ... | {INDEX|KEY} [index_name] [index_type] (index_col_name,...) [index_option] ... | [CONSTRAINT [symbol]] UNIQUE [INDEX|KEY] [index_name] [index_type] (index_col_name,...) [index_option] ... | {FULLTEXT|SPATIAL} [INDEX|KEY] [index_name] (index_col_name,...) [index_option] ... | [CONSTRAINT [symbol]] FOREIGN KEY [index_name] (index_col_name,...) reference_definition | CHECK (expr) )

Return values

CreateDefinition

createDefinitionItem()

Parse the definition of a single column or index


    protected
                    createDefinitionItem() : AbstractCreateDefinitionItem

Return values

AbstractCreateDefinitionItem

createForeignKeyDefinitionItem()

Parses a foreign key definition item contained in the create definition


    protected
                    createForeignKeyDefinitionItem() : CreateForeignKeyDefinitionItem

Return values

CreateForeignKeyDefinitionItem

createIndexDefinitionItem()

Parses an index definition item contained in the create definition


    protected
                    createIndexDefinitionItem() : CreateIndexDefinitionItem

Return values

CreateIndexDefinitionItem

createTableClause()

CreateTableClause ::= CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name


    protected
                    createTableClause() : CreateTableClause

Return values

CreateTableClause

createTableStatement()

CreateTableStatement ::= CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name (create_definition,...) [tbl_options]


    protected
                    createTableStatement() : CreateTableStatement

Return values

CreateTableStatement

dataTypeLength()

Determine length parameter of a column field definition, i.E. INT(11) or VARCHAR(255)


    protected
                    dataTypeLength([bool $required = false ]) : int

Parameters

$required : bool = false

Return values

int

enumerationDataTypeOptions()

Parse shared options for enumeration datatypes (ENUM and SET)


    protected
                    enumerationDataTypeOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

fractionalSecondsPart()

Determine the fractional seconds part support for TIME, DATETIME and TIMESTAMP columns


    protected
                    fractionalSecondsPart() : int

Return values

int

indexColumnName()

IndexColumnName ::= col_name [(length)] [ASC | DESC]


    protected
                    indexColumnName() : IndexColumnName

Return values

IndexColumnName

numericDataTypeOptions()

Parse common options for numeric datatypes


    protected
                    numericDataTypeOptions() : array<string|int, mixed>

Return values

array<string|int, mixed>

peekBeyondClosingParenthesis()

Peeks beyond the matched closing parenthesis and returns the first token after that one.


    protected
                    peekBeyondClosingParenthesis([bool $resetPeek = true ]) : Token

Parameters

$resetPeek : bool = true: Reset peek after finding the closing parenthesis.

Return values

Token

referenceDefinition()

ReferenceDefinition ::= REFERENCES tbl_name (index_col_name,...) [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE] [ON DELETE reference_option] [ON UPDATE reference_option]


    protected
                    referenceDefinition() : ReferenceDefinition

Return values

ReferenceDefinition

referenceOption()

ReferenceOption ::= RESTRICT | CASCADE | SET NULL | NO ACTION


    protected
                    referenceOption() : string

Return values

string

schemaObjectName()

Certain objects within MySQL, including database, table, index, column, alias, view, stored procedure, partition, tablespace, and other object names are known as identifiers.


    protected
                    schemaObjectName() : Identifier

Return values

Identifier

tableOptions()

Parse MySQL table options


    protected
                    tableOptions() : array<string|int, mixed>

ENGINE [=] engine_name | AUTO_INCREMENT [=] value | AVG_ROW_LENGTH [=] value | [DEFAULT] CHARACTER SET [=] charset_name | CHECKSUM [=] {0 | 1} | [DEFAULT] COLLATE [=] collation_name | COMMENT [=] 'string' | COMPRESSION [=] {'ZLIB'|'LZ4'|'NONE'} | CONNECTION [=] 'connect_string' | DATA DIRECTORY [=] 'absolute path to directory' | DELAY_KEY_WRITE [=] {0 | 1} | ENCRYPTION [=] {'Y' | 'N'} | INDEX DIRECTORY [=] 'absolute path to directory' | INSERT_METHOD [=] { NO | FIRST | LAST } | KEY_BLOCK_SIZE [=] value | MAX_ROWS [=] value | MIN_ROWS [=] value | PACK_KEYS [=] {0 | 1 | DEFAULT} | PASSWORD [=] 'string' | ROW_FORMAT [=] {DEFAULT|DYNAMIC|FIXED|COMPRESSED|REDUNDANT|COMPACT} | STATS_AUTO_RECALC [=] {DEFAULT|0|1} | STATS_PERSISTENT [=] {DEFAULT|0|1} | STATS_SAMPLE_PAGES [=] value | TABLESPACE tablespace_name | UNION [=] (tbl_name[,tbl_name]...)

Return values

array<string|int, mixed>

tableOptionValue()

Return the value of an option, skipping the optional equal sign.


    protected
                    tableOptionValue() : mixed

valueList()

Return all defined values for an enumeration datatype (ENUM, SET)


    protected
                    valueList() : array<string|int, mixed>

Return values

array<string|int, mixed>

valueListItem()

Return a value list item for an enumeration set


    protected
                    valueListItem() : string

Return values

string

Parser

Tags

Table of Contents

Properties

Methods

Properties

$lexer

$statement

Methods

__construct()

Parameters

createStatement()

Tags

Return values

free()

Parameters

getAST()

Tags

Return values

getLexer()

Tags

Return values

indexName()

Tags

Return values

indexOptions()

Tags

Return values

indexType()

Tags

Return values

match()

Parameters

Tags

parse()

Tags

Return values

queryLanguage()

Tags

Return values

semanticalError()

Parameters

Tags

syntaxError()

Parameters

Tags

characterDataTypeOptions()

Tags

Return values

columnDataType()

Tags

Return values

columnDefaultValue()

Tags

createColumnDefinitionItem()

Tags

Return values

createDefinition()

Tags

Return values

createDefinitionItem()

Tags

Return values

createForeignKeyDefinitionItem()

Tags

Return values

createIndexDefinitionItem()

Tags

Return values

createTableClause()

Tags

Return values

createTableStatement()

Tags

Return values

dataTypeLength()

Parameters

Tags

Return values

enumerationDataTypeOptions()