461 lines
13 KiB
PHP
461 lines
13 KiB
PHP
|
<?php declare(strict_types=1);
|
||
|
|
/*
|
||
|
|
* This file is part of sebastian/exporter.
|
||
|
|
*
|
||
|
|
* (c) Sebastian Bergmann <sebastian@phpunit.de>
|
||
|
|
*
|
||
|
|
* For the full copyright and license information, please view the LICENSE
|
||
|
|
* file that was distributed with this source code.
|
||
|
|
*/
|
||
|
|
namespace SebastianBergmann\Exporter;
|
||
|
|
|
||
|
|
use const COUNT_RECURSIVE;
|
||
|
|
use function assert;
|
||
|
|
use function bin2hex;
|
||
|
|
use function count;
|
||
|
|
use function get_resource_type;
|
||
|
|
use function gettype;
|
||
|
|
use function implode;
|
||
|
|
use function ini_get;
|
||
|
|
use function ini_set;
|
||
|
|
use function is_array;
|
||
|
|
use function is_bool;
|
||
|
|
use function is_float;
|
||
|
|
use function is_object;
|
||
|
|
use function is_resource;
|
||
|
|
use function is_string;
|
||
|
|
use function mb_strlen;
|
||
|
|
use function mb_substr;
|
||
|
|
use function preg_match;
|
||
|
|
use function spl_object_id;
|
||
|
|
use function sprintf;
|
||
|
|
use function str_repeat;
|
||
|
|
use function str_replace;
|
||
|
|
use function strtr;
|
||
|
|
use function var_export;
|
||
|
|
use BackedEnum;
|
||
|
|
use Google\Protobuf\Internal\Message;
|
||
|
|
use ReflectionClass;
|
||
|
|
use ReflectionObject;
|
||
|
|
use SebastianBergmann\RecursionContext\Context as RecursionContext;
|
||
|
|
use SplObjectStorage;
|
||
|
|
use stdClass;
|
||
|
|
use UnitEnum;
|
||
|
|
|
||
|
|
final readonly class Exporter
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @var non-negative-int
|
||
|
|
*/
|
||
|
|
private int $shortenArraysLongerThan;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @var positive-int
|
||
|
|
*/
|
||
|
|
private int $maxLengthForStrings;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param non-negative-int $shortenArraysLongerThan
|
||
|
|
* @param positive-int $maxLengthForStrings
|
||
|
|
*/
|
||
|
|
public function __construct(int $shortenArraysLongerThan = 0, int $maxLengthForStrings = 40)
|
||
|
|
{
|
||
|
|
$this->shortenArraysLongerThan = $shortenArraysLongerThan;
|
||
|
|
$this->maxLengthForStrings = $maxLengthForStrings;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Exports a value as a string.
|
||
|
|
*
|
||
|
|
* The output of this method is similar to the output of print_r(), but
|
||
|
|
* improved in various aspects:
|
||
|
|
*
|
||
|
|
* - NULL is rendered as "null" (instead of "")
|
||
|
|
* - TRUE is rendered as "true" (instead of "1")
|
||
|
|
* - FALSE is rendered as "false" (instead of "")
|
||
|
|
* - Strings are always quoted with single quotes
|
||
|
|
* - Carriage returns and newlines are normalized to \n
|
||
|
|
* - Recursion and repeated rendering is treated properly
|
||
|
|
*/
|
||
|
|
public function export(mixed $value, int $indentation = 0): string
|
||
|
|
{
|
||
|
|
return $this->recursiveExport($value, $indentation);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array<mixed> $data
|
||
|
|
* @param positive-int $maxLengthForStrings
|
||
|
|
*/
|
||
|
|
public function shortenedRecursiveExport(array &$data, int $maxLengthForStrings = 40, ?RecursionContext $processed = null): string
|
||
|
|
{
|
||
|
|
if ($maxLengthForStrings === 40) {
|
||
|
|
$maxLengthForStrings = $this->maxLengthForStrings;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$processed) {
|
||
|
|
$processed = new RecursionContext;
|
||
|
|
}
|
||
|
|
|
||
|
|
$overallCount = @count($data, COUNT_RECURSIVE);
|
||
|
|
$counter = 0;
|
||
|
|
|
||
|
|
$export = $this->shortenedCountedRecursiveExport($data, $processed, $counter, $maxLengthForStrings);
|
||
|
|
|
||
|
|
if ($this->shortenArraysLongerThan > 0 &&
|
||
|
|
$overallCount > $this->shortenArraysLongerThan) {
|
||
|
|
$export .= sprintf(', ...%d more elements', $overallCount - $this->shortenArraysLongerThan);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $export;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Exports a value into a single-line string.
|
||
|
|
*
|
||
|
|
* The output of this method is similar to the output of
|
||
|
|
* SebastianBergmann\Exporter\Exporter::export().
|
||
|
|
*
|
||
|
|
* Newlines are replaced by the visible string '\n'.
|
||
|
|
* Contents of arrays and objects (if any) are replaced by '...'.
|
||
|
|
*
|
||
|
|
* @param positive-int $maxLengthForStrings
|
||
|
|
*/
|
||
|
|
public function shortenedExport(mixed $value, int $maxLengthForStrings = 40): string
|
||
|
|
{
|
||
|
|
if ($maxLengthForStrings === 40) {
|
||
|
|
$maxLengthForStrings = $this->maxLengthForStrings;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_string($value)) {
|
||
|
|
$string = str_replace("\n", '', $this->exportString($value));
|
||
|
|
|
||
|
|
if (mb_strlen($string) > $maxLengthForStrings) {
|
||
|
|
return mb_substr($string, 0, $maxLengthForStrings - 10) . '...' . mb_substr($string, -7);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $string;
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($value instanceof BackedEnum) {
|
||
|
|
return sprintf(
|
||
|
|
'%s Enum (%s, %s)',
|
||
|
|
$value::class,
|
||
|
|
$value->name,
|
||
|
|
$this->export($value->value),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($value instanceof UnitEnum) {
|
||
|
|
return sprintf(
|
||
|
|
'%s Enum (%s)',
|
||
|
|
$value::class,
|
||
|
|
$value->name,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_object($value)) {
|
||
|
|
return sprintf(
|
||
|
|
'%s Object (%s)',
|
||
|
|
$value::class,
|
||
|
|
$this->countProperties($value) > 0 ? '...' : '',
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_array($value)) {
|
||
|
|
return sprintf(
|
||
|
|
'[%s]',
|
||
|
|
count($value) > 0 ? '...' : '',
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->export($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Converts an object to an array containing all of its private, protected
|
||
|
|
* and public properties.
|
||
|
|
*
|
||
|
|
* @return array<mixed>
|
||
|
|
*/
|
||
|
|
public function toArray(mixed $value): array
|
||
|
|
{
|
||
|
|
if (!is_object($value)) {
|
||
|
|
return (array) $value;
|
||
|
|
}
|
||
|
|
|
||
|
|
$array = [];
|
||
|
|
|
||
|
|
foreach ((array) $value as $key => $val) {
|
||
|
|
// Exception traces commonly reference hundreds to thousands of
|
||
|
|
// objects currently loaded in memory. Including them in the result
|
||
|
|
// has a severe negative performance impact.
|
||
|
|
if ("\0Error\0trace" === $key || "\0Exception\0trace" === $key) {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
// properties are transformed to keys in the following way:
|
||
|
|
// private $propertyName => "\0ClassName\0propertyName"
|
||
|
|
// protected $propertyName => "\0*\0propertyName"
|
||
|
|
// public $propertyName => "propertyName"
|
||
|
|
if (preg_match('/\0.+\0(.+)/', (string) $key, $matches)) {
|
||
|
|
$key = $matches[1];
|
||
|
|
}
|
||
|
|
|
||
|
|
// See https://github.com/php/php-src/commit/5721132
|
||
|
|
if ($key === "\0gcdata") {
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
$array[$key] = $val;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Some internal classes like SplObjectStorage do not work with the
|
||
|
|
// above (fast) mechanism nor with reflection in Zend.
|
||
|
|
// Format the output similarly to print_r() in this case
|
||
|
|
if ($value instanceof SplObjectStorage) {
|
||
|
|
foreach ($value as $_value) {
|
||
|
|
$array['Object #' . spl_object_id($_value)] = [
|
||
|
|
'obj' => $_value,
|
||
|
|
'inf' => $value->getInfo(),
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
$value->rewind();
|
||
|
|
}
|
||
|
|
|
||
|
|
return $array;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function countProperties(object $value): int
|
||
|
|
{
|
||
|
|
if (!$this->canBeReflected($value)) {
|
||
|
|
// @codeCoverageIgnoreStart
|
||
|
|
return count($this->toArray($value));
|
||
|
|
// @codeCoverageIgnoreEnd
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$value instanceof stdClass) {
|
||
|
|
// using ReflectionClass prevents initialization of potential lazy objects
|
||
|
|
return count((new ReflectionClass($value))->getProperties());
|
||
|
|
}
|
||
|
|
|
||
|
|
return count((new ReflectionObject($value))->getProperties());
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array<mixed> $data
|
||
|
|
* @param positive-int $maxLengthForStrings
|
||
|
|
*/
|
||
|
|
private function shortenedCountedRecursiveExport(array &$data, RecursionContext $processed, int &$counter, int $maxLengthForStrings): string
|
||
|
|
{
|
||
|
|
$result = [];
|
||
|
|
|
||
|
|
$array = $data;
|
||
|
|
|
||
|
|
/* @noinspection UnusedFunctionResultInspection */
|
||
|
|
$processed->add($data);
|
||
|
|
|
||
|
|
foreach ($array as $key => $value) {
|
||
|
|
if ($this->shortenArraysLongerThan > 0 &&
|
||
|
|
$counter > $this->shortenArraysLongerThan) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_array($value)) {
|
||
|
|
assert(is_array($data[$key]) || is_object($data[$key]));
|
||
|
|
|
||
|
|
if ($processed->contains($data[$key]) !== false) {
|
||
|
|
$result[] = '*RECURSION*';
|
||
|
|
} else {
|
||
|
|
assert(is_array($data[$key]));
|
||
|
|
|
||
|
|
$result[] = '[' . $this->shortenedCountedRecursiveExport($data[$key], $processed, $counter, $maxLengthForStrings) . ']';
|
||
|
|
}
|
||
|
|
} else {
|
||
|
|
$result[] = $this->shortenedExport($value, $maxLengthForStrings);
|
||
|
|
}
|
||
|
|
|
||
|
|
$counter++;
|
||
|
|
}
|
||
|
|
|
||
|
|
return implode(', ', $result);
|
||
|
|
}
|
||
|
|
|
||
|
|
private function recursiveExport(mixed &$value, int $indentation = 0, ?RecursionContext $processed = null): string
|
||
|
|
{
|
||
|
|
if ($value === null) {
|
||
|
|
return 'null';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_bool($value)) {
|
||
|
|
return $value ? 'true' : 'false';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_float($value)) {
|
||
|
|
return $this->exportFloat($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (gettype($value) === 'resource (closed)') {
|
||
|
|
return 'resource (closed)';
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_resource($value)) {
|
||
|
|
return sprintf(
|
||
|
|
'resource(%d) of type (%s)',
|
||
|
|
(int) $value,
|
||
|
|
get_resource_type($value),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($value instanceof BackedEnum) {
|
||
|
|
return sprintf(
|
||
|
|
'%s Enum #%d (%s, %s)',
|
||
|
|
$value::class,
|
||
|
|
spl_object_id($value),
|
||
|
|
$value->name,
|
||
|
|
$this->export($value->value),
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($value instanceof UnitEnum) {
|
||
|
|
return sprintf(
|
||
|
|
'%s Enum #%d (%s)',
|
||
|
|
$value::class,
|
||
|
|
spl_object_id($value),
|
||
|
|
$value->name,
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_string($value)) {
|
||
|
|
return $this->exportString($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (!$processed) {
|
||
|
|
$processed = new RecursionContext;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_array($value)) {
|
||
|
|
return $this->exportArray($value, $processed, $indentation);
|
||
|
|
}
|
||
|
|
|
||
|
|
if (is_object($value)) {
|
||
|
|
return $this->exportObject($value, $processed, $indentation);
|
||
|
|
}
|
||
|
|
|
||
|
|
return var_export($value, true);
|
||
|
|
}
|
||
|
|
|
||
|
|
private function exportFloat(float $value): string
|
||
|
|
{
|
||
|
|
$precisionBackup = ini_get('precision');
|
||
|
|
|
||
|
|
ini_set('precision', '-1');
|
||
|
|
|
||
|
|
$valueAsString = (string) $value;
|
||
|
|
|
||
|
|
ini_set('precision', $precisionBackup);
|
||
|
|
|
||
|
|
if ((string) (int) $value === $valueAsString) {
|
||
|
|
return $valueAsString . '.0';
|
||
|
|
}
|
||
|
|
|
||
|
|
return $valueAsString;
|
||
|
|
}
|
||
|
|
|
||
|
|
private function exportString(string $value): string
|
||
|
|
{
|
||
|
|
// Match for most non-printable chars somewhat taking multibyte chars into account
|
||
|
|
if (preg_match('/[^\x09-\x0d\x1b\x20-\xff]/', $value)) {
|
||
|
|
return 'Binary String: 0x' . bin2hex($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
return "'" .
|
||
|
|
strtr(
|
||
|
|
$value,
|
||
|
|
[
|
||
|
|
"\r\n" => '\r\n' . "\n",
|
||
|
|
"\n\r" => '\n\r' . "\n",
|
||
|
|
"\r" => '\r' . "\n",
|
||
|
|
"\n" => '\n' . "\n",
|
||
|
|
],
|
||
|
|
) .
|
||
|
|
"'";
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param array<mixed> $value
|
||
|
|
*/
|
||
|
|
private function exportArray(array &$value, RecursionContext $processed, int $indentation): string
|
||
|
|
{
|
||
|
|
if (($key = $processed->contains($value)) !== false) {
|
||
|
|
return 'Array &' . $key;
|
||
|
|
}
|
||
|
|
|
||
|
|
$array = $value;
|
||
|
|
$key = $processed->add($value);
|
||
|
|
$values = '';
|
||
|
|
|
||
|
|
if (count($array) > 0) {
|
||
|
|
$whitespace = str_repeat(' ', 4 * $indentation);
|
||
|
|
|
||
|
|
foreach ($array as $k => $v) {
|
||
|
|
$values .=
|
||
|
|
$whitespace
|
||
|
|
. ' ' .
|
||
|
|
$this->recursiveExport($k, $indentation)
|
||
|
|
. ' => ' .
|
||
|
|
$this->recursiveExport($value[$k], $indentation + 1, $processed)
|
||
|
|
. ",\n";
|
||
|
|
}
|
||
|
|
|
||
|
|
$values = "\n" . $values . $whitespace;
|
||
|
|
}
|
||
|
|
|
||
|
|
return 'Array &' . (string) $key . ' [' . $values . ']';
|
||
|
|
}
|
||
|
|
|
||
|
|
private function exportObject(object $value, RecursionContext $processed, int $indentation): string
|
||
|
|
{
|
||
|
|
$class = $value::class;
|
||
|
|
|
||
|
|
if ($processed->contains($value) !== false) {
|
||
|
|
return $class . ' Object #' . spl_object_id($value);
|
||
|
|
}
|
||
|
|
|
||
|
|
$processed->add($value);
|
||
|
|
|
||
|
|
$array = $this->toArray($value);
|
||
|
|
$buffer = '';
|
||
|
|
|
||
|
|
if (count($array) > 0) {
|
||
|
|
$whitespace = str_repeat(' ', 4 * $indentation);
|
||
|
|
|
||
|
|
foreach ($array as $k => $v) {
|
||
|
|
$buffer .=
|
||
|
|
$whitespace
|
||
|
|
. ' ' .
|
||
|
|
$this->recursiveExport($k, $indentation)
|
||
|
|
. ' => ' .
|
||
|
|
$this->recursiveExport($v, $indentation + 1, $processed)
|
||
|
|
. ",\n";
|
||
|
|
}
|
||
|
|
|
||
|
|
$buffer = "\n" . $buffer . $whitespace;
|
||
|
|
}
|
||
|
|
|
||
|
|
return $class . ' Object #' . spl_object_id($value) . ' (' . $buffer . ')';
|
||
|
|
}
|
||
|
|
|
||
|
|
private function canBeReflected(object $object): bool
|
||
|
|
{
|
||
|
|
/** @phpstan-ignore class.notFound */
|
||
|
|
if ($object instanceof Message) {
|
||
|
|
// @codeCoverageIgnoreStart
|
||
|
|
return false;
|
||
|
|
// @codeCoverageIgnoreEnd
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
}
|