AbstractDumper.php 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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\Dumper;
  11. use Symfony\Component\VarDumper\Cloner\Data;
  12. use Symfony\Component\VarDumper\Cloner\DumperInterface;
  13. /**
  14. * Abstract mechanism for dumping a Data object.
  15. *
  16. * @author Nicolas Grekas <p@tchwork.com>
  17. */
  18. abstract class AbstractDumper implements DataDumperInterface, DumperInterface
  19. {
  20. const DUMP_LIGHT_ARRAY = 1;
  21. const DUMP_STRING_LENGTH = 2;
  22. const DUMP_COMMA_SEPARATOR = 4;
  23. const DUMP_TRAILING_COMMA = 8;
  24. public static $defaultOutput = 'php://output';
  25. protected $line = '';
  26. protected $lineDumper;
  27. protected $outputStream;
  28. protected $decimalPoint; // This is locale dependent
  29. protected $indentPad = ' ';
  30. protected $flags;
  31. private $charset;
  32. /**
  33. * @param callable|resource|string|null $output A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
  34. * @param string $charset The default character encoding to use for non-UTF8 strings
  35. * @param int $flags A bit field of static::DUMP_* constants to fine tune dumps representation
  36. */
  37. public function __construct($output = null, $charset = null, $flags = 0)
  38. {
  39. $this->flags = (int) $flags;
  40. $this->setCharset($charset ?: ini_get('php.output_encoding') ?: ini_get('default_charset') ?: 'UTF-8');
  41. $this->decimalPoint = (string) 0.5;
  42. $this->decimalPoint = $this->decimalPoint[1];
  43. $this->setOutput($output ?: static::$defaultOutput);
  44. if (!$output && is_string(static::$defaultOutput)) {
  45. static::$defaultOutput = $this->outputStream;
  46. }
  47. }
  48. /**
  49. * Sets the output destination of the dumps.
  50. *
  51. * @param callable|resource|string $output A line dumper callable, an opened stream or an output path
  52. *
  53. * @return callable|resource|string The previous output destination
  54. */
  55. public function setOutput($output)
  56. {
  57. $prev = null !== $this->outputStream ? $this->outputStream : $this->lineDumper;
  58. if (is_callable($output)) {
  59. $this->outputStream = null;
  60. $this->lineDumper = $output;
  61. } else {
  62. if (is_string($output)) {
  63. $output = fopen($output, 'wb');
  64. }
  65. $this->outputStream = $output;
  66. $this->lineDumper = array($this, 'echoLine');
  67. }
  68. return $prev;
  69. }
  70. /**
  71. * Sets the default character encoding to use for non-UTF8 strings.
  72. *
  73. * @param string $charset The default character encoding to use for non-UTF8 strings
  74. *
  75. * @return string The previous charset
  76. */
  77. public function setCharset($charset)
  78. {
  79. $prev = $this->charset;
  80. $charset = strtoupper($charset);
  81. $charset = null === $charset || 'UTF-8' === $charset || 'UTF8' === $charset ? 'CP1252' : $charset;
  82. $this->charset = $charset;
  83. return $prev;
  84. }
  85. /**
  86. * Sets the indentation pad string.
  87. *
  88. * @param string $pad A string the will be prepended to dumped lines, repeated by nesting level
  89. *
  90. * @return string The indent pad
  91. */
  92. public function setIndentPad($pad)
  93. {
  94. $prev = $this->indentPad;
  95. $this->indentPad = $pad;
  96. return $prev;
  97. }
  98. /**
  99. * Dumps a Data object.
  100. *
  101. * @param Data $data A Data object
  102. * @param callable|resource|string|true|null $output A line dumper callable, an opened stream, an output path or true to return the dump
  103. *
  104. * @return string|null The dump as string when $output is true
  105. */
  106. public function dump(Data $data, $output = null)
  107. {
  108. if ($returnDump = true === $output) {
  109. $output = fopen('php://memory', 'r+b');
  110. }
  111. if ($output) {
  112. $prevOutput = $this->setOutput($output);
  113. }
  114. try {
  115. $data->dump($this);
  116. $this->dumpLine(-1);
  117. if ($returnDump) {
  118. $result = stream_get_contents($output, -1, 0);
  119. fclose($output);
  120. return $result;
  121. }
  122. } finally {
  123. if ($output) {
  124. $this->setOutput($prevOutput);
  125. }
  126. }
  127. }
  128. /**
  129. * Dumps the current line.
  130. *
  131. * @param int $depth The recursive depth in the dumped structure for the line being dumped
  132. */
  133. protected function dumpLine($depth)
  134. {
  135. call_user_func($this->lineDumper, $this->line, $depth, $this->indentPad);
  136. $this->line = '';
  137. }
  138. /**
  139. * Generic line dumper callback.
  140. *
  141. * @param string $line The line to write
  142. * @param int $depth The recursive depth in the dumped structure
  143. * @param string $indentPad The line indent pad
  144. */
  145. protected function echoLine($line, $depth, $indentPad)
  146. {
  147. if (-1 !== $depth) {
  148. fwrite($this->outputStream, str_repeat($indentPad, $depth).$line."\n");
  149. }
  150. }
  151. /**
  152. * Converts a non-UTF-8 string to UTF-8.
  153. *
  154. * @param string $s The non-UTF-8 string to convert
  155. *
  156. * @return string The string converted to UTF-8
  157. */
  158. protected function utf8Encode($s)
  159. {
  160. if (preg_match('//u', $s)) {
  161. return $s;
  162. }
  163. if (!function_exists('iconv')) {
  164. throw new \RuntimeException('Unable to convert a non-UTF-8 string to UTF-8: required function iconv() does not exist. You should install ext-iconv or symfony/polyfill-iconv.');
  165. }
  166. if (false !== $c = @iconv($this->charset, 'UTF-8', $s)) {
  167. return $c;
  168. }
  169. if ('CP1252' !== $this->charset && false !== $c = @iconv('CP1252', 'UTF-8', $s)) {
  170. return $c;
  171. }
  172. return iconv('CP850', 'UTF-8', $s);
  173. }
  174. }