-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
TextFormatter.php
154 lines (138 loc) · 4.8 KB
/
TextFormatter.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Error\Debug;
use InvalidArgumentException;
/**
* A Debugger formatter for generating unstyled plain text output.
*
* Provides backwards compatible output with the historical output of
* `Debugger::exportVar()`
*
* @internal
*/
class TextFormatter implements FormatterInterface
{
/**
* @inheritDoc
*/
public function formatWrapper(string $contents, array $location): string
{
$template = <<<TEXT
%s
########## DEBUG ##########
%s
###########################
TEXT;
$lineInfo = '';
if (isset($location['file'], $location['file'])) {
$lineInfo = sprintf('%s (line %s)', $location['file'], $location['line']);
}
return sprintf($template, $lineInfo, $contents);
}
/**
* Convert a tree of NodeInterface objects into a plain text string.
*
* @param \Cake\Error\Debug\NodeInterface $node The node tree to dump.
* @return string
*/
public function dump(NodeInterface $node): string
{
$indent = 0;
return $this->export($node, $indent);
}
/**
* Convert a tree of NodeInterface objects into a plain text string.
*
* @param \Cake\Error\Debug\NodeInterface $var The node tree to dump.
* @param int $indent The current indentation level.
* @return string
*/
protected function export(NodeInterface $var, int $indent): string
{
if ($var instanceof ScalarNode) {
return match ($var->getType()) {
'bool' => $var->getValue() ? 'true' : 'false',
'null' => 'null',
'string' => "'" . (string)$var->getValue() . "'",
default => "({$var->getType()}) {$var->getValue()}",
};
}
if ($var instanceof ArrayNode) {
return $this->exportArray($var, $indent + 1);
}
if ($var instanceof ClassNode || $var instanceof ReferenceNode) {
return $this->exportObject($var, $indent + 1);
}
if ($var instanceof SpecialNode) {
return $var->getValue();
}
throw new InvalidArgumentException('Unknown node received ' . $var::class);
}
/**
* Export an array type object
*
* @param \Cake\Error\Debug\ArrayNode $var The array to export.
* @param int $indent The current indentation level.
* @return string Exported array.
*/
protected function exportArray(ArrayNode $var, int $indent): string
{
$out = '[';
$break = "\n" . str_repeat(' ', $indent);
$end = "\n" . str_repeat(' ', $indent - 1);
$vars = [];
foreach ($var->getChildren() as $item) {
$val = $item->getValue();
$vars[] = $break . $this->export($item->getKey(), $indent) . ' => ' . $this->export($val, $indent);
}
if (count($vars)) {
return $out . implode(',', $vars) . $end . ']';
}
return $out . ']';
}
/**
* Handles object to string conversion.
*
* @param \Cake\Error\Debug\ClassNode|\Cake\Error\Debug\ReferenceNode $var Object to convert.
* @param int $indent Current indentation level.
* @return string
* @see \Cake\Error\Debugger::exportVar()
*/
protected function exportObject(ClassNode|ReferenceNode $var, int $indent): string
{
$out = '';
$props = [];
if ($var instanceof ReferenceNode) {
return "object({$var->getValue()}) id:{$var->getId()} {}";
}
$out .= "object({$var->getValue()}) id:{$var->getId()} {";
$break = "\n" . str_repeat(' ', $indent);
$end = "\n" . str_repeat(' ', $indent - 1) . '}';
foreach ($var->getChildren() as $property) {
$visibility = $property->getVisibility();
$name = $property->getName();
if ($visibility && $visibility !== 'public') {
$props[] = "[{$visibility}] {$name} => " . $this->export($property->getValue(), $indent);
} else {
$props[] = "{$name} => " . $this->export($property->getValue(), $indent);
}
}
if (count($props)) {
return $out . $break . implode($break, $props) . $end;
}
return $out . '}';
}
}