summaryrefslogtreecommitdiff
path: root/vendor/doctrine/orm/src/Query/Printer.php
blob: db1f159ae13bf27f9ac22d18fb705c4b8c46deb1 (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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<?php

declare(strict_types=1);

namespace Doctrine\ORM\Query;

use function str_repeat;

/**
 * A parse tree printer for Doctrine Query Language parser.
 *
 * @link        http://www.phpdoctrine.org
 */
class Printer
{
    /** Current indentation level */
    protected int $indent = 0;

    /**
     * Constructs a new parse tree printer.
     *
     * @param bool $silent Parse tree will not be printed if true.
     */
    public function __construct(protected bool $silent = false)
    {
    }

    /**
     * Prints an opening parenthesis followed by production name and increases
     * indentation level by one.
     *
     * This method is called before executing a production.
     *
     * @param string $name Production name.
     */
    public function startProduction(string $name): void
    {
        $this->println('(' . $name);
        $this->indent++;
    }

    /**
     * Decreases indentation level by one and prints a closing parenthesis.
     *
     * This method is called after executing a production.
     */
    public function endProduction(): void
    {
        $this->indent--;
        $this->println(')');
    }

    /**
     * Prints text indented with spaces depending on current indentation level.
     *
     * @param string $str The text.
     */
    public function println(string $str): void
    {
        if (! $this->silent) {
            echo str_repeat('    ', $this->indent), $str, "\n";
        }
    }
}