blob: bbe22ea1ef0a368f16cf251de7c9e608ca315063 (
plain) (
blame)
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
|
<?php
namespace Drupal\Core\Template;
use Twig\Environment;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;
/**
* A class providing Drupal Twig Debug extension.
*/
final class DebugExtension extends AbstractExtension {
/**
* The Symfony VarDumper class.
*
* Defined as a string because the Symfony VarDumper does not always exist.
*
* @var string
*/
private const SYMFONY_VAR_DUMPER_CLASS = '\Symfony\Component\VarDumper\VarDumper';
/**
* {@inheritdoc}
*/
public function getFunctions(): array {
// Override Twig built in debugger when Symfony VarDumper is available to
// improve developer experience.
// @see \Twig\Extension\DebugExtension
// @see \Symfony\Component\VarDumper\VarDumper
if (class_exists(self::SYMFONY_VAR_DUMPER_CLASS)) {
return [
new TwigFunction(
'dump',
[self::class, 'dump'],
[
'needs_context' => TRUE,
'needs_environment' => TRUE,
'is_variadic' => TRUE,
]
),
];
}
return [];
}
/**
* Dumps information about variables using Symfony VarDumper.
*
* @param \Twig\Environment $env
* The Twig environment.
* @param array $context
* Variables from the Twig template.
* @param array $variables
* (optional) Variable(s) to dump.
*/
public static function dump(Environment $env, array $context, ...$variables): void {
if (!$env->isDebug()) {
return;
}
if (class_exists(self::SYMFONY_VAR_DUMPER_CLASS)) {
if (func_num_args() === 2) {
call_user_func(self::SYMFONY_VAR_DUMPER_CLASS . '::dump', $context);
}
else {
array_walk($variables, self::SYMFONY_VAR_DUMPER_CLASS . '::dump');
}
}
else {
throw new \LogicException('Could not dump the variable because symfony/var-dumper component is not installed.');
}
}
}
|
