Dumper: added support for dumping references

Author: dg

src/PhpGenerator/Dumper.php

@@ -23,13 +23,16 @@ final class Dumper
 	public int $wrapLength = 120;
 	public string $indentation = "\t";
 	public bool $customObjects = true;
+	public bool $ref = false;
+	private array $references;
 
 
 	/**
 	 * Returns a PHP representation of a variable.
 	 */
 	public function dump(mixed $var, int $column = 0): string
 	{
+		$this->references = [];
 		return $this->dumpVar($var, [], 0, $column);
 	}
 
@@ -122,7 +125,8 @@ private function dumpArray(array $var, array $parents, int $level, int $column):
 			$res .= $this->dumpVar($v, $parents, $level + 1, $column + strlen($res));
 
 			if (
-				str_contains($res, "\n")
+				($this->ref && (\ReflectionReference::fromArrayElement($var, $k))?->getId())
+				|| str_contains($res, "\n")
 				|| $level * self::IndentLength + $column + strlen($res) + 3 > $this->wrapLength // 3 = [],
 			) { // wrap
 				$space = str_repeat($this->indentation, $level);
@@ -131,10 +135,19 @@ private function dumpArray(array $var, array $parents, int $level, int $column):
 					$keyPart = $hideKeys && ($k !== $keys[0] || $k === 0)
 						? ''
 						: $this->dumpVar($k) . ' => ';
-					$res .= $this->indentation
-						. $keyPart
-						. $this->dumpVar($v, $parents, $level + 1, strlen($keyPart))
-						. ",\n$space";
+					$res .= $this->indentation . $keyPart;
+					$ref = $this->ref
+						? (\ReflectionReference::fromArrayElement($var, $k))?->getId()
+						: null;
+					if ($ref !== null) {
+						if (isset($this->references[$ref])) {
+							$res .= '&$__ref[' . $this->references[$ref] . "],\n$space";
+							continue;
+						} else {
+							$res .= '$__ref[' . ($this->references[$ref] = count($this->references) + 1) . '] = ';
+						}
+					}
+					$res .= $this->dumpVar($v, $parents, $level + 1, strlen($keyPart)) . ",\n$space";
 				}
 				break;
 			}

tests/PhpGenerator/Dumper.dump().references.phpt

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * Test: Nette\PhpGenerator\Dumper::dump()
+ */
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\Dumper;
+use Tester\Assert;
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$val = 123;
+
+// no reference
+$dumper = new Dumper;
+$dumper->ref = false;
+Assert::same('[123]', $dumper->dump([&$val]));
+
+
+// array
+$dumper = new Dumper;
+$dumper->ref = true;
+
+same('[
+	$__ref[1] = 123,
+]', $dumper->dump([&$val]));
+
+same('[
+	$__ref[1] = 123,
+	&$__ref[1],
+]', $dumper->dump([&$val, &$val]));
+
+$arr = [1];
+$arr[] = &$arr;
+same('[
+	$__ref[1] = 123,
+	&$__ref[1],
+]', $dumper->dump([&$arr]));