Docs For Class SQL

$comments = array()

[line 122]

Access: public

Type:

array

[ Top ]

$dialects = array(
        'ANSI',
        'MySQL',
    )

[line 134]

Access: public
Usedby: SQL_Parser::setDialect() - R

Type:

array

[ Top ]

$functions = array()

[line 80]

Access: public
Usedby: SQL_Parser::isFunc() - R
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

$lexer =

[line 68]

Access: public
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::parseFieldOptions()
Usedby: SQL_Parser::raiseError() - R
Usedby: SQL_Parser::__construct() - W to create it
Usedby: SQL_Parser::getParams() - R
Usedby: SQL_Parser::getTok() - R

Type:

SQL_Parser_Lexer

[ Top ]

$lexeropts = array()

[line 110]

Access: public
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::__construct() - R
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

$notes = array()

[line 139]

Access: public

Type:

mixed

[ Top ]

$operators = array()

[line 98]

Access: public
Usedby: SQL_Parser::isOperator() - R
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

$parseropts = array()

[line 116]

Access: public
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

$quotes = array()

[line 128]

Access: public

Type:

array

[ Top ]

$symbols = array()

[line 92]

Access: public
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::isReserved() - R
Usedby: SQL_Parser::setDialect() - W to set it
Usedby: SQL_Parser::__construct() - R

Type:

array

[ Top ]

$synonyms = array()

[line 104]

Access: public
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

$token =

[line 74]

Access: public
Usedby: SQL_Parser::isOperator() - R
Usedby: SQL_Parser::getTok() - W to set it
Usedby: SQL_Parser::parseFieldOptions()
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::isReserved() - R
Usedby: SQL_Parser::isCommand() - R
Usedby: SQL_Parser::getParams() - R
Usedby: SQL_Parser::raiseError() - R
Usedby: SQL_Parser::isType() - R
Usedby: SQL_Parser::isVal() - R
Usedby: SQL_Parser::isFunc() - R

Type:

string

[ Top ]

$types = array()

[line 86]

Access: public
Usedby: SQL_Parser::isType() - R
Usedby: SQL_Parser::setDialect() - W to set it

Type:

array

[ Top ]

__construct (Constructor) [line 165]

SQL_Parser __construct(
[string
$string = null], [string
$dialect = 'ANSI'])

Constructor

Access: public
Uses: SQL_Parser_Lexer - to create an Object
Uses: SQL_Parser_Lexer::$symbols - W to set it
Uses: SQL_Parser::setDialect()
Uses: SQL_Parser::$symbols - R
Uses: SQL_Parser::$lexer - W to create it
Uses: SQL_Parser::$lexeropts - R
Uses: is_string()

Parameters:

string	`$string`	—	the SQL query to parse
string	`$dialect`	—	the SQL dialect

[ Top ]

getParams [line 249]

mixed getParams(
array
&$values, array
&$types, [integer
$i = 0])

extracts parameters from a function call

this function should be called if an opening brace is found, so the first call to $this->getTok() will return first param or the closing )

Return: true on success, otherwise Error
Access: public
Uses: SQL_Parser_Lexer::$tokText - R
Usedby: SQL_Parser::parseCondition()
Uses: SQL_Parser::raiseError()
Uses: SQL_Parser::isVal()
Uses: SQL_Parser::$token - R
Uses: SQL_Parser::getTok()
Uses: SQL_Parser::$lexer - R

Parameters:

array	`&$values`	—	to set it
array	`&$types`	—	to set it
integer	`$i`	—	position

[ Top ]

getTok [line 417]

void getTok(
)

retrieves next token

Access: public
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::parseFieldOptions()
Usedby: SQL_Parser::getParams()
Uses: SQL_Parser_Lexer::lex()
Uses: SQL_Parser::$lexer - R
Uses: SQL_Parser::$token - W to set it

[ Top ]

initLexer [line 175]

void initLexer(

$string)

Parameters:

$string —

[ Top ]

isCommand [line 374]

boolean isCommand(
)

Returns true if current token is a command, otherwise false

Return: true if current token is a command
Access: public
Uses: SQL_Parser::$token - R
Uses: SQL_Parser::$commands - R

[ Top ]

isFunc [line 360]

boolean isFunc(
)

Returns true if current token is a function, otherwise false

Return: true if current token is a function
Access: public
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::parseFieldOptions()
Uses: SQL_Parser::$functions - R
Uses: SQL_Parser::$token - R

[ Top ]

isOperator [line 402]

boolean isOperator(
)

Returns true if current token is an operator, otherwise false

Return: true if current token is an operator
Access: public
Usedby: SQL_Parser::parseCondition()
Uses: SQL_Parser::$token - R
Uses: SQL_Parser::$operators - R

[ Top ]

isReserved [line 388]

boolean isReserved(
)

Returns true if current token is a reserved word, otherwise false

Return: true if current token is a reserved word
Access: public
Usedby: SQL_Parser::parseCondition()
Uses: SQL_Parser::$token - R
Uses: SQL_Parser::$symbols - R

[ Top ]

isType [line 330]

boolean isType(
)

Returns true if current token is a variable type name, otherwise false

Return: true if current token is a variable type name
Access: public
Uses: SQL_Parser::$types - R
Uses: SQL_Parser::$token - R

[ Top ]

isVal [line 343]

boolean isVal(
)

Returns true if current token is a value, otherwise false

Return: true if current token is a value
Access: public
Usedby: SQL_Parser::parseFieldOptions()
Usedby: SQL_Parser::getParams()
Uses: SQL_Parser::$token - R

[ Top ]

parse [line 1778]

void parse(
[
$string = null])

Access: public

Parameters:

$string —

[ Top ]

parseCondition [line 647]

array parseCondition(
)

parses conditions usually used in WHERE or ON

Return: parsed condition
Access: public
Uses: SQL_Parser_Lexer::$tokText
Uses: SQL_Parser::raiseError()
Uses: SQL_Parser_Lexer::pushBack()
Uses: SQL_Parser_Lexer::unget()
Usedby: SQL_Parser::parseFieldOptions()
Uses: SQL_Parser::parseSelect()
Usedby: SQL_Parser::parseCondition()
Uses: SQL_Parser::parseFunctionOpts()
Uses: SQL_Parser::getTok()
Uses: SQL_Parser::getParams()
Uses: SQL_Parser::$token
Uses: SQL_Parser::isFunc()
Uses: SQL_Parser::isOperator()
Uses: SQL_Parser::parseCondition()
Uses: SQL_Parser::isReserved()
Uses: SQL_Parser::$lexer

[ Top ]

parseCreate [line 1066]

mixed parseCreate(
)

Return: array parsed create on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseQuery()

[ Top ]

parseDelete [line 1342]

mixed parseDelete(
)

DELETE FROM tablename WHERE searchclause

Return: array parsed delete on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseQuery()

[ Top ]

parseDrop [line 1377]

mixed parseDrop(
)

Return: array parsed drop on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseQuery()

[ Top ]

parseFieldList [line 874]

mixed parseFieldList(
)

Return: array parsed field list on success, otherwise Error
Access: public

[ Top ]

parseFieldOptions [line 440]

array parseFieldOptions(
)

Parses field/column options, usually for an CREATE or ALTER TABLE statement

Return: parsed field options
Access: public
Uses: SQL_Parser::raiseError()
Uses: SQL_Parser_Lexer::$tokText
Uses: SQL_Parser_Lexer::unget()
Uses: SQL_Parser::parseFunctionOpts()
Uses: SQL_Parser::parseCondition()
Uses: SQL_Parser::$token
Uses: SQL_Parser::getTok()
Uses: SQL_Parser::isFunc()
Uses: SQL_Parser::isVal()
Uses: SQL_Parser::$lexer

[ Top ]

parseFrom [line 1326]

void parseFrom(
)

Access: public

[ Top ]

parseFunctionOpts [line 1042]

mixed parseFunctionOpts(
)

Parses parameters in a function call

Return: array parsed function options on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::parseFieldOptions()

[ Top ]

parseIdentifier [line 1417]

void parseIdentifier(
[
$type = 'column'])

[[db.].table].column [[AS] alias]

Access: public

Parameters:

$type —

[ Top ]

parseInsert [line 1110]

mixed parseInsert(
)

Return: array parsed insert on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseQuery()

[ Top ]

parseLock [line 1619]

void parseLock(
)

tbl_name [[AS] alias] lock_type[, ...]

Access: public

[ Top ]

parseLockType [line 1652]

void parseLockType(
)

READ [LOCAL] | [LOW_PRIORITY] WRITE

Access: public

[ Top ]

parseQuery [line 1701]

array parseQuery(
)

Return: parsed data
Access: public
Uses: SQL_Parser::parseUpdate()
Uses: SQL_Parser::parseSelect()
Uses: SQL_Parser::raiseError()
Uses: SQL_Parser_Lexer
Uses: SQL_Parser_Lexer::$symbols
Uses: SQL_Parser::parseInsert()
Uses: SQL_Parser::parseDrop()
Uses: SQL_Parser::$symbols
Uses: SQL_Parser::$lexeropts
Uses: SQL_Parser::$token
Uses: SQL_Parser::getTok()
Uses: SQL_Parser::parseDelete()
Uses: SQL_Parser::parseCreate()
Uses: SQL_Parser::$lexer

[ Top ]

parseSelect [line 1476]

mixed parseSelect(
[
$subSelect = false])

Return: array parsed select on success, otherwise Error
Access: public
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::parseCondition()

Parameters:

$subSelect —

[ Top ]

parseSelectExpression [line 758]

void parseSelectExpression(
)

Access: public

[ Top ]

parseTableFactor [line 1227]

void parseTableFactor(
)

Access: public

[ Top ]

parseTableReference [line 1242]

void parseTableReference(
)

Access: public

[ Top ]

parseUpdate [line 1181]

mixed parseUpdate(
)

UPDATE tablename SET (colname = (value|colname) (,|WHERE searchclause))+

Return: array parsed update on success, otherwise Error
Todo: This is incorrect. multiple where clauses would parse
Access: public
Usedby: SQL_Parser::parseQuery()

[ Top ]

raiseError [line 299]

Error raiseError(
string
$message)

Access: public
Uses: substr()
Uses: str_repeat()
Usedby: SQL_Parser::setDialect()
Usedby: SQL_Parser::getParams()
Usedby: SQL_Parser::parseQuery()
Usedby: SQL_Parser::parseCondition()
Usedby: SQL_Parser::parseFieldOptions()
Uses: strlen()
Uses: SQL_Parser_Lexer::$tokText - R
Uses: SQL_Parser::$token - R
Uses: SQL_Parser::$lexer - R
Uses: is_null()
Uses: SQL_Parser_Lexer::$lineBegin - R
Uses: SQL_Parser_Lexer::$lineNo - R
Uses: SQL_Parser_Lexer::$tokPtr - R
Uses: SQL_Parser_Lexer::$stringLen - R
Uses: SQL_Parser_Lexer::$string - R
Uses: abs()

Parameters:

string $message — error message

[ Top ]

setDialect [line 202]

mixed setDialect(
string
$dialect)

loads SQL dialect specific data

Return: true on success, otherwise Error
Access: public
Uses: SQL_Parser::$synonyms - W to set it
Uses: SQL_Parser::$types - W to set it
Uses: SQL_Parser::raiseError()
Uses: SQL_Parser::$symbols - W to set it
Usedby: SQL_Parser::__construct()
Uses: SQL_Parser::$parseropts - W to set it
Uses: SQL_Parser::$dialects - R
Uses: SQL_Parser::$commands - W to set it
Uses: SQL_Parser::$functions - W to set it
Uses: SQL_Parser::$lexeropts - W to set it
Uses: SQL_Parser::$operators - W to set it
Uses: in_array()

Parameters:

string $dialect — the SQL dialect to use

[ Top ]

Class: SQL_Parser

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$comments = array()

$dialects = array( 'ANSI', 'MySQL', )

$functions = array()

$lexer =

$lexeropts = array()

$notes = array()

$operators = array()

$parseropts = array()

$quotes = array()

$symbols = array()

$synonyms = array()

$token =

$types = array()

Method Detail

__construct (Constructor) [line 165]

Parameters:

getParams [line 249]

Parameters:

getTok [line 417]

initLexer [line 175]

Parameters:

isCommand [line 374]

isFunc [line 360]

isOperator [line 402]

isReserved [line 388]

isType [line 330]

isVal [line 343]

parse [line 1778]

Parameters:

parseCondition [line 647]

parseCreate [line 1066]

parseDelete [line 1342]

parseDrop [line 1377]

parseFieldList [line 874]

parseFieldOptions [line 440]

parseFrom [line 1326]

parseFunctionOpts [line 1042]

parseIdentifier [line 1417]

Parameters:

parseInsert [line 1110]

parseLock [line 1619]

parseLockType [line 1652]

parseQuery [line 1701]

parseSelect [line 1476]

Parameters:

parseSelectExpression [line 758]

parseTableFactor [line 1227]

parseTableReference [line 1242]

parseUpdate [line 1181]

raiseError [line 299]

Parameters:

setDialect [line 202]

Parameters:

$dialects = array(
'ANSI',
'MySQL',
)