TYPO3\CMS\Core\Database\Schema\Parser\Parser Class Reference

Public Member Functions
	__construct (private readonly Lexer $lexer,)
list< Table >	parse (string $statement)
	getAST (string $statement)

Private Member Functions
	match (int $token)
	syntaxError (string $expected='', ?Token $token=null)
	semanticError (string $message='')
	createStatement ()
	createTableStatement ()
	createTableClause ()
	createDefinition ()
	createDefinitionItem ()
	createIndexDefinitionItem ()
	createForeignKeyDefinitionItem ()
	indexName ()
	indexType ()
	indexOptions ()
	createColumnDefinitionItem ()
	columnDataType ()
	columnDefaultValue ()
	dataTypeLength (bool $required=false)
	dataTypeDecimals ()
	numericDataTypeOptions ()
	fractionalSecondsPart ()
	characterDataTypeOptions ()
	enumerationDataTypeOptions ()
	valueList ()
	valueListItem ()
	referenceDefinition ()
	indexColumnName ()
	referenceOption ()
	tableOptions ()
	tableOptionValue ()
	schemaObjectName ()

Private Attributes
string	$statement

Detailed Description

An LL(*) recursive-descent parser for MySQL CREATE TABLE statements. Parses a CREATE TABLE statement, reports any errors in it, and generates an AST.

Definition at line 74 of file Parser.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::__construct

(

private readonly Lexer

$lexer

)

Definition at line 79 of file Parser.php.

Member Function Documentation

characterDataTypeOptions()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::characterDataTypeOptions ( )

private

Parse common options for numeric data types

Exceptions

StatementException

Definition at line 1022 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BINARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHARACTER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COLLATE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SET, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

columnDataType()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::columnDataType ( )

private

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

Exceptions

StatementException

Definition at line 710 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\characterDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeDecimals(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeLength(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\enumerationDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\fractionalSecondsPart(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\numericDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BIGINT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BINARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BIT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BLOB, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHAR, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DATE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DATETIME, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DECIMAL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DOUBLE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ENUM, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FLOAT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INTEGER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_JSON, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_LONGBLOB, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_LONGTEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MEDIUMBLOB, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MEDIUMINT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MEDIUMTEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NUMERIC, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PRECISION, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_REAL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SET, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SMALLINT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TIME, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TIMESTAMP, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TINYBLOB, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TINYINT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TINYTEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_VARBINARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_VARCHAR, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_YEAR, and TYPO3\CMS\Core\Database\Schema\Parser\Parser\valueList().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem().

columnDefaultValue()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::columnDefaultValue ( )

private

DefaultValue::= DEFAULT default_value

Exceptions

StatementException

Definition at line 904 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CURRENT_TIMESTAMP, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DEFAULT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FLOAT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INTEGER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NULL, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem().

createColumnDefinitionItem()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createColumnDefinitionItem ( )

private

CreateColumnDefinitionItem ::= col_name column_definition

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]

Exceptions

StatementException

Definition at line 585 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDefaultValue(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_AUTO_INCREMENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COLUMN_FORMAT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DEFAULT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DISK, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DYNAMIC, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FIXED, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MEMORY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NOT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NULL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PRIMARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_REFERENCES, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STORAGE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UNIQUE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinitionItem().

createDefinition()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createDefinition ( )

private

Parses the table field/index definition

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

Exceptions

StatementException

Definition at line 288 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableStatement().

createDefinitionItem()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createDefinitionItem ( )

private

Parse the definition of a single column or index

Exceptions

StatementException

Definition at line 328 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createForeignKeyDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\semanticError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHECK, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CONSTRAINT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FOREIGN, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FULLTEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INDEX, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PRIMARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SPATIAL, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UNIQUE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinition().

createForeignKeyDefinitionItem()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createForeignKeyDefinitionItem ( )

private

Parses a foreign key definition item contained in the create definition

Exceptions

StatementException

Definition at line 458 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FOREIGN, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinitionItem().

createIndexDefinitionItem()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createIndexDefinitionItem ( )

private

Parses an index definition item contained in the create definition

Exceptions

StatementException

Definition at line 367 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FULLTEXT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INDEX, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PRIMARY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SPATIAL, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UNIQUE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinitionItem().

createStatement()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createStatement ( )

private

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

Exceptions

StatementException

Definition at line 219 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\$statement, TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableStatement(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CREATE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SEMICOLON, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TABLE, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TEMPORARY.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\getAST().

createTableClause()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createTableClause ( )

private

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

Exceptions

StatementException

Definition at line 249 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_EXISTS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_IF, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NOT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TABLE, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TEMPORARY.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableStatement().

createTableStatement()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::createTableStatement ( )

private

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

Exceptions

StatementException

Definition at line 235 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableClause(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SEMICOLON, and TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptions().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createStatement().

dataTypeDecimals()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::dataTypeDecimals ( )

private

Determine length and optional decimal parameter of a column field definition, i.E. DECIMAL(10,6)

Exceptions

StatementException

Definition at line 947 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INTEGER, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

dataTypeLength()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::dataTypeLength ( bool  $required = false )

private

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

Exceptions

StatementException

Definition at line 924 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\semanticError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INTEGER, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\fractionalSecondsPart(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName().

enumerationDataTypeOptions()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::enumerationDataTypeOptions ( )

private

Parse shared options for enumeration datatypes (ENUM and SET)

Exceptions

StatementException

Definition at line 1060 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHARACTER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COLLATE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SET, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

fractionalSecondsPart()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::fractionalSecondsPart ( )

private

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

Exceptions

StatementException

Definition at line 1005 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeLength(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\semanticError().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

getAST()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::getAST

(

string

$statement

)

Parses and builds AST for the given Query. Only public for testing, the core API method is parse().

Exceptions

StatementException

Definition at line 109 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\$statement, TYPO3\CMS\Core\Database\Schema\Parser\Parser\createStatement(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CREATE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\parse().

indexColumnName()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::indexColumnName ( )

private

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

Exceptions

StatementException

Definition at line 1179 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeLength(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ASC, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DESC.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createForeignKeyDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition().

indexName()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::indexName ( )

private

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

Exceptions

StatementException

Definition at line 490 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_USING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createForeignKeyDefinitionItem(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem().

indexOptions()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::indexOptions ( )

private

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

Exceptions

StatementException

Definition at line 537 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_EQUALS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY_BLOCK_SIZE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PARSER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_USING, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_WITH.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem().

indexType()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::indexType ( )

private

IndexType ::= USING { BTREE | HASH }

Exceptions

StatementException

Definition at line 504 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_BTREE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_HASH, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_USING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem().

match()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::match ( int  $token )

private

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

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

Parameters

int

$token

‪The token type.

Exceptions

StatementException

‪If the tokens don't match.

Definition at line 135 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DELETE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_FULL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_IDENTIFIER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MATCH, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ON, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PARTIAL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SIMPLE, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UPDATE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\characterDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDefaultValue(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createForeignKeyDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createStatement(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableClause(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeDecimals(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeLength(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\enumerationDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\numericDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceOption(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptionValue(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\valueList(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\valueListItem().

numericDataTypeOptions()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::numericDataTypeOptions ( )

private

Parse common options for numeric data types

Exceptions

StatementException

Definition at line 974 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UNSIGNED, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ZEROFILL.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

parse()

list<Table> TYPO3\CMS\Core\Database\Schema\Parser\Parser::parse

(

string

$statement

)

Parses a statement string.

Returns

‪list<Table>

Exceptions

SchemaException

Definition at line 92 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\getAST().

referenceDefinition()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::referenceDefinition ( )

private

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

Exceptions

StatementException

Definition at line 1131 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceOption(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\schemaObjectName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DELETE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MATCH, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ON, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_REFERENCES, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_UPDATE.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\createForeignKeyDefinitionItem().

referenceOption()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::referenceOption ( )

private

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

Exceptions

StatementException

Definition at line 1201 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ACTION, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CASCADE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NO, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_NULL, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_RESTRICT, and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SET.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition().

schemaObjectName()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::schemaObjectName ( )

private

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

Definition at line 1432 of file Parser.php.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableClause(), TYPO3\CMS\Core\Database\Schema\Parser\AST\Identifier\getQuotedName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexColumnName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexName(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexOptions(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition().

semanticError()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::semanticError ( string  $message = '' )

private

Generates a new semantic error.

Parameters

string

$message

‪Optional message.

Exceptions

StatementException

Definition at line 190 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\$statement, TYPO3\CMS\Core\Database\Schema\Exception\StatementException\semanticError(), and TYPO3\CMS\Core\Database\Schema\Exception\StatementException\sqlError().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\dataTypeLength(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\fractionalSecondsPart().

syntaxError()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::syntaxError ( string  $expected = '', ?Token  $token = null  )

private

Generates a new syntax error.

Parameters

string	$expected	‪Expected string.
Token | null	$token	‪Got token.

Exceptions

StatementException

Definition at line 170 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Exception\StatementException\sqlError(), and TYPO3\CMS\Core\Database\Schema\Exception\StatementException\syntaxError().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\characterDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createColumnDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createIndexDefinitionItem(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\createStatement(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\enumerationDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\getAST(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\indexType(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\numericDataTypeOptions(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceDefinition(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\referenceOption(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptions().

tableOptions()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::tableOptions ( )

private

Parse MySQL table options

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 =

Exceptions

StatementException

Definition at line 1262 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\syntaxError(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_AUTO_INCREMENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_AVG_ROW_LENGTH, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHARACTER, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CHECKSUM, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COLLATE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMPRESSION, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CONNECTION, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DATA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DEFAULT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DELAY_KEY_WRITE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_DIRECTORY, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ENCRYPTION, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ENGINE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INDEX, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_INSERT_METHOD, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_KEY_BLOCK_SIZE, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MAX_ROWS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_MIN_ROWS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PACK_KEYS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_PASSWORD, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_ROW_FORMAT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SEMICOLON, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_SET, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STATS_AUTO_RECALC, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STATS_PERSISTENT, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STATS_SAMPLE_PAGES, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_TABLESPACE, and TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptionValue().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createTableStatement().

tableOptionValue()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::tableOptionValue ( )

private

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

Exceptions

StatementException

Definition at line 1418 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_EQUALS.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\tableOptions().

valueList()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::valueList ( )

private

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

Exceptions

StatementException

Definition at line 1094 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_CLOSE_PARENTHESIS, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_COMMA, TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_OPEN_PARENTHESIS, and TYPO3\CMS\Core\Database\Schema\Parser\Parser\valueListItem().

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\columnDataType().

valueListItem()

TYPO3\CMS\Core\Database\Schema\Parser\Parser::valueListItem ( )

private

Return a value list item for an enumeration set

Exceptions

StatementException

Definition at line 1116 of file Parser.php.

References TYPO3\CMS\Core\Database\Schema\Parser\Parser\match(), and TYPO3\CMS\Core\Database\Schema\Parser\Lexer\T_STRING.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\valueList().

Member Data Documentation

$statement

string TYPO3\CMS\Core\Database\Schema\Parser\Parser::$statement

private

Definition at line 77 of file Parser.php.

Referenced by TYPO3\CMS\Core\Database\Schema\Parser\Parser\createStatement(), TYPO3\CMS\Core\Database\Schema\Parser\Parser\getAST(), and TYPO3\CMS\Core\Database\Schema\Parser\Parser\semanticError().