forked from phpmyadmin/sql-parser
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathComponent.php
More file actions
39 lines (34 loc) · 1.38 KB
/
Component.php
File metadata and controls
39 lines (34 loc) · 1.38 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<?php
declare(strict_types=1);
namespace PhpMyAdmin\SqlParser;
use Stringable;
/**
* Defines a component that is later extended to parse specialized components or keywords.
*
* There is a small difference between *Component and *Keyword classes: usually, *Component parsers can be reused in
* multiple situations and *Keyword parsers count on the *Component classes to do their job.
*
* A component (of a statement) is a part of a statement that is common to multiple query types.
*/
interface Component extends Stringable
{
/**
* Parses the tokens contained in the given list in the context of the given parser.
*
* @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 mixed
*/
public static function parse(Parser $parser, TokensList $list, array $options = []);
/**
* Builds the string representation of a component of this type.
*
* In other words, this function represents the inverse function of {@see Component::parse()}.
*
* @param mixed $component the component to be built
* @param array<string, mixed> $options parameters for building
*/
public static function build($component, array $options = []): string;
}