summaryrefslogtreecommitdiff
path: root/vendor/doctrine/orm/src/Query/TreeWalker.php
blob: 6c215773d4f8e37184ff61940cbc594e6f6af207 (plain)
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
40
41
42
43
44
<?php

declare(strict_types=1);

namespace Doctrine\ORM\Query;

use Doctrine\ORM\AbstractQuery;

/**
 * Interface for walkers of DQL ASTs (abstract syntax trees).
 *
 * @psalm-import-type QueryComponent from Parser
 */
interface TreeWalker
{
    /**
     * Initializes TreeWalker with important information about the ASTs to be walked.
     *
     * @psalm-param array<string, QueryComponent> $queryComponents The query components (symbol table).
     */
    public function __construct(AbstractQuery $query, ParserResult $parserResult, array $queryComponents);

    /**
     * Returns internal queryComponents array.
     *
     * @psalm-return array<string, QueryComponent>
     */
    public function getQueryComponents(): array;

    /**
     * Walks down a SelectStatement AST node.
     */
    public function walkSelectStatement(AST\SelectStatement $selectStatement): void;

    /**
     * Walks down an UpdateStatement AST node.
     */
    public function walkUpdateStatement(AST\UpdateStatement $updateStatement): void;

    /**
     * Walks down a DeleteStatement AST node.
     */
    public function walkDeleteStatement(AST\DeleteStatement $deleteStatement): void;
}