blob: b223e065106d2a5cca56304d6b26475a6675589e [file] [log] [blame]
Matthias Andreas Benkard7b2a3a12021-08-16 10:57:25 +02001<?php
2
3/*
4 * This file is part of the Symfony package.
5 *
6 * (c) Fabien Potencier <fabien@symfony.com>
7 *
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
10 */
11
12namespace Symfony\Component\VarDumper;
13
14use Symfony\Component\HttpFoundation\Request;
15use Symfony\Component\HttpFoundation\RequestStack;
16use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
17use Symfony\Component\VarDumper\Caster\ReflectionCaster;
18use Symfony\Component\VarDumper\Cloner\VarCloner;
19use Symfony\Component\VarDumper\Dumper\CliDumper;
20use Symfony\Component\VarDumper\Dumper\ContextProvider\CliContextProvider;
21use Symfony\Component\VarDumper\Dumper\ContextProvider\RequestContextProvider;
22use Symfony\Component\VarDumper\Dumper\ContextProvider\SourceContextProvider;
23use Symfony\Component\VarDumper\Dumper\ContextualizedDumper;
24use Symfony\Component\VarDumper\Dumper\HtmlDumper;
25use Symfony\Component\VarDumper\Dumper\ServerDumper;
26
27// Load the global dump() function
28require_once __DIR__.'/Resources/functions/dump.php';
29
30/**
31 * @author Nicolas Grekas <p@tchwork.com>
32 */
33class VarDumper
34{
35 private static $handler;
36
37 public static function dump($var)
38 {
39 if (null === self::$handler) {
40 self::register();
41 }
42
43 return (self::$handler)($var);
44 }
45
46 public static function setHandler(callable $callable = null)
47 {
48 $prevHandler = self::$handler;
49
50 // Prevent replacing the handler with expected format as soon as the env var was set:
51 if (isset($_SERVER['VAR_DUMPER_FORMAT'])) {
52 return $prevHandler;
53 }
54
55 self::$handler = $callable;
56
57 return $prevHandler;
58 }
59
60 private static function register(): void
61 {
62 $cloner = new VarCloner();
63 $cloner->addCasters(ReflectionCaster::UNSET_CLOSURE_FILE_INFO);
64
65 $format = $_SERVER['VAR_DUMPER_FORMAT'] ?? null;
66 switch (true) {
67 case 'html' === $format:
68 $dumper = new HtmlDumper();
69 break;
70 case 'cli' === $format:
71 $dumper = new CliDumper();
72 break;
73 case 'server' === $format:
74 case $format && 'tcp' === parse_url($format, \PHP_URL_SCHEME):
75 $host = 'server' === $format ? $_SERVER['VAR_DUMPER_SERVER'] ?? '127.0.0.1:9912' : $format;
76 $dumper = \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? new CliDumper() : new HtmlDumper();
77 $dumper = new ServerDumper($host, $dumper, self::getDefaultContextProviders());
78 break;
79 default:
80 $dumper = \in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) ? new CliDumper() : new HtmlDumper();
81 }
82
83 if (!$dumper instanceof ServerDumper) {
84 $dumper = new ContextualizedDumper($dumper, [new SourceContextProvider()]);
85 }
86
87 self::$handler = function ($var) use ($cloner, $dumper) {
88 $dumper->dump($cloner->cloneVar($var));
89 };
90 }
91
92 private static function getDefaultContextProviders(): array
93 {
94 $contextProviders = [];
95
96 if (!\in_array(\PHP_SAPI, ['cli', 'phpdbg'], true) && (class_exists(Request::class))) {
97 $requestStack = new RequestStack();
98 $requestStack->push(Request::createFromGlobals());
99 $contextProviders['request'] = new RequestContextProvider($requestStack);
100 }
101
102 $fileLinkFormatter = class_exists(FileLinkFormatter::class) ? new FileLinkFormatter(null, $requestStack ?? null) : null;
103
104 return $contextProviders + [
105 'cli' => new CliContextProvider(),
106 'source' => new SourceContextProvider(null, null, $fileLinkFormatter),
107 ];
108 }
109}