aboutsummaryrefslogtreecommitdiff
path: root/lib/exTpl/Context.php
blob: 309174fe02a6d806a68d3413301404cc51373d46 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
<?php
/**
 * Context.php - template parser symbol table
 *
 * A Context object represents the symbol table used to resolve
 *  symbol names to their values in the local scope. Each context
 *  may inherit symbol definitions from its parent context.
 *
 * @copyright 2013  Elmar Ludwig
 * @license GPL2 or any later version
 */

namespace exTpl;

use Closure;

class Context
{
    private array $bindings;
    private Closure|null $escape;
    private Context|null $parent;

    /**
     * Initializes a new Context instance with the given bindings.
     *
     * @param array $bindings symbol table
     * @param Context|null $parent parent context (or NULL)
     */
    public function __construct(array $bindings, Context $parent = null)
    {
        $this->bindings = $bindings;
        $this->parent   = $parent;
    }

    /**
     * Looks up the value of a symbol in this context and returns it.
     * The reserved symbol "this" is an alias for the current context.
     *
     * @param string $key symbol name
     */
    public function lookup(string $key): mixed
    {
        if (isset($this->bindings[$key])) {
            return $this->bindings[$key];
        } else if ($this->parent) {
            return $this->parent->lookup($key);
        }

        return null;
    }

    /**
     * Enables or disables automatic escaping for template values.
     *
     * @param callable|null $escape escape callback or null
     */
    public function autoescape(?callable $escape): void
    {
        $this->escape = $escape ? $escape(...) : null;
    }

    /**
     * Escapes the given value using the configured strategy.
     *
     * @param mixed $value expression value
     */
    public function escape(mixed $value): mixed
    {
        if (isset($this->escape)) {
            $value = call_user_func($this->escape, $value);
        } else if ($this->parent) {
            $value = $this->parent->escape($value);
        }

        return $value;
    }
}