Helpers divided into Helpers & Dumper

Author: dg

src/PhpGenerator/Dumper.php

@@ -0,0 +1,209 @@
+<?php
+
+/**
+ * This file is part of the Nette Framework (https://nette.org)
+ * Copyright (c) 2004 David Grudl (https://davidgrudl.com)
+ */
+
+declare(strict_types=1);
+
+namespace Nette\PhpGenerator;
+
+use Nette;
+
+
+/**
+ * PHP code generator utils.
+ */
+final class Dumper
+{
+	use Nette\StaticClass;
+
+	public const WRAP_LENGTH = 100;
+
+	private const INDENT_LENGTH = 4;
+
+	private const MAX_DEPTH = 50;
+
+
+	/**
+	 * Returns a PHP representation of a variable.
+	 */
+	public static function dump($var): string
+	{
+		return self::_dump($var);
+	}
+
+
+	private static function _dump(&$var, int $level = 0)
+	{
+		if ($var instanceof PhpLiteral) {
+			return (string) $var;
+
+		} elseif (is_float($var)) {
+			return var_export($var, true);
+
+		} elseif ($var === null) {
+			return 'null';
+
+		} elseif (is_string($var) && (preg_match('#[^\x09\x20-\x7E\xA0-\x{10FFFF}]#u', $var) || preg_last_error())) {
+			static $table;
+			if ($table === null) {
+				foreach (array_merge(range("\x00", "\x1F"), range("\x7F", "\xFF")) as $ch) {
+					$table[$ch] = '\x' . str_pad(dechex(ord($ch)), 2, '0', STR_PAD_LEFT);
+				}
+				$table['\\'] = '\\\\';
+				$table["\r"] = '\r';
+				$table["\n"] = '\n';
+				$table["\t"] = '\t';
+				$table['$'] = '\$';
+				$table['"'] = '\"';
+			}
+			return '"' . strtr($var, $table) . '"';
+
+		} elseif (is_string($var)) {
+			return "'" . preg_replace('#\'|\\\\(?=[\'\\\\]|$)#D', '\\\\$0', $var) . "'";
+
+		} elseif (is_array($var)) {
+			$space = str_repeat("\t", $level);
+
+			static $marker;
+			if ($marker === null) {
+				$marker = uniqid("\x00", true);
+			}
+			if (empty($var)) {
+				$out = '';
+
+			} elseif ($level > self::MAX_DEPTH || isset($var[$marker])) {
+				throw new Nette\InvalidArgumentException('Nesting level too deep or recursive dependency.');
+
+			} else {
+				$out = '';
+				$outWrapped = "\n$space";
+				$var[$marker] = true;
+				$counter = 0;
+				foreach ($var as $k => &$v) {
+					if ($k !== $marker) {
+						$item = ($k === $counter ? '' : self::_dump($k, $level + 1) . ' => ') . self::_dump($v, $level + 1);
+						$counter = is_int($k) ? max($k + 1, $counter) : $counter;
+						$out .= ($out === '' ? '' : ', ') . $item;
+						$outWrapped .= "\t$item,\n$space";
+					}
+				}
+				unset($var[$marker]);
+			}
+			$wrap = strpos($out, "\n") !== false || strlen($out) > self::WRAP_LENGTH - $level * self::INDENT_LENGTH;
+			return '[' . ($wrap ? $outWrapped : $out) . ']';
+
+		} elseif ($var instanceof \Serializable) {
+			$var = serialize($var);
+			return 'unserialize(' . self::_dump($var, $level) . ')';
+
+		} elseif ($var instanceof \Closure) {
+			throw new Nette\InvalidArgumentException('Cannot dump closure.');
+
+		} elseif (is_object($var)) {
+			$class = get_class($var);
+			if ((new \ReflectionObject($var))->isAnonymous()) {
+				throw new Nette\InvalidArgumentException('Cannot dump anonymous class.');
+
+			} elseif (in_array($class, ['DateTime', 'DateTimeImmutable'], true)) {
+				return self::format("new $class(?, new DateTimeZone(?))", $var->format('Y-m-d H:i:s.u'), $var->getTimeZone()->getName());
+			}
+
+			$arr = (array) $var;
+			$space = str_repeat("\t", $level);
+
+			static $list = [];
+			if ($level > self::MAX_DEPTH || in_array($var, $list, true)) {
+				throw new Nette\InvalidArgumentException('Nesting level too deep or recursive dependency.');
+
+			} else {
+				$out = "\n";
+				$list[] = $var;
+				if (method_exists($var, '__sleep')) {
+					foreach ($var->__sleep() as $v) {
+						$props[$v] = $props["\x00*\x00$v"] = $props["\x00$class\x00$v"] = true;
+					}
+				}
+				foreach ($arr as $k => &$v) {
+					if (!isset($props) || isset($props[$k])) {
+						$out .= "$space\t" . self::_dump($k, $level + 1) . ' => ' . self::_dump($v, $level + 1) . ",\n";
+					}
+				}
+				array_pop($list);
+				$out .= $space;
+			}
+			return $class === 'stdClass'
+				? "(object) [$out]"
+				: __CLASS__ . "::createObject('$class', [$out])";
+
+		} elseif (is_resource($var)) {
+			throw new Nette\InvalidArgumentException('Cannot dump resource.');
+
+		} else {
+			return var_export($var, true);
+		}
+	}
+
+
+	/**
+	 * Generates PHP statement.
+	 */
+	public static function format(string $statement, ...$args): string
+	{
+		$tokens = preg_split('#(\.\.\.\?|\$\?|->\?|::\?|\\\\\?|\?\*|\?)#', $statement, -1, PREG_SPLIT_DELIM_CAPTURE);
+		$res = '';
+		foreach ($tokens as $n => $token) {
+			if ($n % 2 === 0) {
+				$res .= $token;
+			} elseif ($token === '\\?') {
+				$res .= '?';
+			} elseif (!$args) {
+				throw new Nette\InvalidArgumentException('Insufficient number of arguments.');
+			} elseif ($token === '?') {
+				$res .= self::dump(array_shift($args));
+			} elseif ($token === '...?' || $token === '?*') {
+				$arg = array_shift($args);
+				if (!is_array($arg)) {
+					throw new Nette\InvalidArgumentException('Argument must be an array.');
+				}
+				$items = [];
+				foreach ($arg as $tmp) {
+					$items[] = self::dump($tmp);
+				}
+				$res .= strlen($tmp = implode(', ', $items)) > self::WRAP_LENGTH && count($items) > 1
+					? "\n" . Nette\Utils\Strings::indent(implode(",\n", $items)) . "\n"
+					: $tmp;
+
+			} else { // $  ->  ::
+				$res .= substr($token, 0, -1) . self::formatMember(array_shift($args));
+			}
+		}
+		if ($args) {
+			throw new Nette\InvalidArgumentException('Insufficient number of placeholders.');
+		}
+		return $res;
+	}
+
+
+	/**
+	 * Returns a PHP representation of a object member.
+	 */
+	private static function formatMember($name): string
+	{
+		return $name instanceof PhpLiteral || !Helpers::isIdentifier($name)
+			? '{' . self::_dump($name) . '}'
+			: $name;
+	}
+
+
+	/**
+	 * @return object
+	 * @internal
+	 */
+	public static function createObject(string $class, array $props)
+	{
+		return unserialize('O' . substr(serialize($class), 1, -1) . substr(serialize($props), 1));
+	}
+}