169 lines
4.5 KiB
PHP
169 lines
4.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace PhpMyAdmin\SqlParser\Components;
|
|
|
|
use PhpMyAdmin\SqlParser\Component;
|
|
use PhpMyAdmin\SqlParser\Context;
|
|
use PhpMyAdmin\SqlParser\Parser;
|
|
use PhpMyAdmin\SqlParser\Token;
|
|
use PhpMyAdmin\SqlParser\TokensList;
|
|
|
|
use function implode;
|
|
use function is_array;
|
|
use function trim;
|
|
|
|
/**
|
|
* The definition of a parameter of a function or procedure.
|
|
*
|
|
* @final
|
|
*/
|
|
class ParameterDefinition extends Component
|
|
{
|
|
/**
|
|
* The name of the new column.
|
|
*
|
|
* @var string
|
|
*/
|
|
public $name;
|
|
|
|
/**
|
|
* Parameter's direction (IN, OUT or INOUT).
|
|
*
|
|
* @var string
|
|
*/
|
|
public $inOut;
|
|
|
|
/**
|
|
* The data type of thew new column.
|
|
*
|
|
* @var DataType
|
|
*/
|
|
public $type;
|
|
|
|
/**
|
|
* @param string $name parameter's name
|
|
* @param string $inOut parameter's directional type (IN / OUT or None)
|
|
* @param DataType $type parameter's type
|
|
*/
|
|
public function __construct($name = null, $inOut = null, $type = null)
|
|
{
|
|
$this->name = $name;
|
|
$this->inOut = $inOut;
|
|
$this->type = $type;
|
|
}
|
|
|
|
/**
|
|
* @param Parser $parser the parser that serves as context
|
|
* @param TokensList $list the list of tokens that are being parsed
|
|
* @param array<string, mixed> $options parameters for parsing
|
|
*
|
|
* @return ParameterDefinition[]
|
|
*/
|
|
public static function parse(Parser $parser, TokensList $list, array $options = [])
|
|
{
|
|
$ret = [];
|
|
|
|
$expr = new static();
|
|
|
|
/**
|
|
* The state of the parser.
|
|
*
|
|
* Below are the states of the parser.
|
|
*
|
|
* 0 -----------------------[ ( ]------------------------> 1
|
|
*
|
|
* 1 ----------------[ IN / OUT / INOUT ]----------------> 1
|
|
* 1 ----------------------[ name ]----------------------> 2
|
|
*
|
|
* 2 -------------------[ data type ]--------------------> 3
|
|
*
|
|
* 3 ------------------------[ , ]-----------------------> 1
|
|
* 3 ------------------------[ ) ]-----------------------> (END)
|
|
*
|
|
* @var int
|
|
*/
|
|
$state = 0;
|
|
|
|
for (; $list->idx < $list->count; ++$list->idx) {
|
|
/**
|
|
* Token parsed at this moment.
|
|
*/
|
|
$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) {
|
|
if (($token->type === Token::TYPE_OPERATOR) && ($token->value === '(')) {
|
|
$state = 1;
|
|
}
|
|
|
|
continue;
|
|
} elseif ($state === 1) {
|
|
if (($token->value === 'IN') || ($token->value === 'OUT') || ($token->value === 'INOUT')) {
|
|
$expr->inOut = $token->value;
|
|
++$list->idx;
|
|
} elseif ($token->value === ')') {
|
|
++$list->idx;
|
|
break;
|
|
} else {
|
|
$expr->name = $token->value;
|
|
$state = 2;
|
|
}
|
|
} elseif ($state === 2) {
|
|
$expr->type = DataType::parse($parser, $list);
|
|
$state = 3;
|
|
} elseif ($state === 3) {
|
|
$ret[] = $expr;
|
|
$expr = new static();
|
|
if ($token->value === ',') {
|
|
$state = 1;
|
|
} elseif ($token->value === ')') {
|
|
++$list->idx;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Last iteration was not saved.
|
|
if (isset($expr->name) && ($expr->name !== '')) {
|
|
$ret[] = $expr;
|
|
}
|
|
|
|
--$list->idx;
|
|
|
|
return $ret;
|
|
}
|
|
|
|
/**
|
|
* @param ParameterDefinition[] $component the component to be built
|
|
* @param array<string, mixed> $options parameters for building
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function build($component, array $options = [])
|
|
{
|
|
if (is_array($component)) {
|
|
return '(' . implode(', ', $component) . ')';
|
|
}
|
|
|
|
$tmp = '';
|
|
if (! empty($component->inOut)) {
|
|
$tmp .= $component->inOut . ' ';
|
|
}
|
|
|
|
return trim(
|
|
$tmp . Context::escape($component->name) . ' ' . $component->type
|
|
);
|
|
}
|
|
}
|