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