phpmyadmin/libraries/sql-parser/src/Fragments/JoinKeyword.php
Dan Ungureanu fc6212b922 Improved documentation.
Updated sql-parser library to udan11/sql-parser@0bff48a.

Signed-off-by: Dan Ungureanu <udan1107@gmail.com>
2015-07-10 23:18:18 +03:00

104 lines
2.5 KiB
PHP

<?php
/**
* `JOIN` keyword parser.
*
* @package SqlParser
* @subpackage Fragments
*/
namespace SqlParser\Fragments;
use SqlParser\Fragment;
use SqlParser\Parser;
use SqlParser\Token;
use SqlParser\TokensList;
/**
* `JOIN` keyword parser.
*
* @category Keywords
* @package SqlParser
* @subpackage Fragments
* @author Dan Ungureanu <udan1107@gmail.com>
* @license http://opensource.org/licenses/GPL-2.0 GNU Public License
*/
class JoinKeyword extends Fragment
{
/**
* Join expression.
*
* @var FieldFragment
*/
public $expr;
/**
* Join conditions.
*
* @var WhereKeyword[]
*/
public $on;
/**
* @param Parser $parser The parser that serves as context.
* @param TokensList $list The list of tokens that are being parsed.
* @param array $options Parameters for parsing.
*
* @return JoinKeyword
*/
public static function parse(Parser $parser, TokensList $list, array $options = array())
{
$ret = new JoinKeyword();
/**
* The state of the parser.
*
* Below are the states of the parser.
*
* 0 -----------------------[ expr ]----------------------> 1
*
* 1 ------------------------[ ON ]-----------------------> 2
*
* 2 --------------------[ conditions ]-------------------> -1
*
* @var int
*/
$state = 0;
for (; $list->idx < $list->count; ++$list->idx) {
/**
* Token parsed at this moment.
* @var Token $token
*/
$token = $list->tokens[$list->idx];
// End of statement.
if ($token->type === Token::TYPE_DELIMITER) {
break;
}
// Skipping whitespaces and comments.
if (($token->type === Token::TYPE_WHITESPACE) || ($token->type === Token::TYPE_COMMENT)) {
continue;
}
if ($state === 0) {
$ret->expr = FieldFragment::parse($parser, $list, array('skipColumn' => true));
$state = 1;
} elseif ($state === 1) {
if (($token->type === Token::TYPE_KEYWORD) && ($token->value === 'ON')) {
$state = 2;
}
} elseif ($state === 2) {
$ret->on = WhereKeyword::parse($parser, $list);
++$list->idx;
break;
}
}
--$list->idx;
return $ret;
}
}