VarDumper.php 3.7 KB

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