-
Notifications
You must be signed in to change notification settings - Fork 0
/
Debugger.php
213 lines (182 loc) · 6.36 KB
/
Debugger.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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<?php
namespace HexMakina\Debugger
{
class Debugger
{
private static array $skip_classes = [__CLASS__];
public function addSkipClasses($skip_classes): void
{
self::$skip_classes = array_merge(self::$skip_classes, $skip_classes);
self::$skip_classes = array_unique(self::$skip_classes);
}
// -- visual dump (display depends on env)
// return the var itself, for easy code debugging
public static function visualDump($var, $var_name = null, $full_backtrace = false)
{
if ($var instanceof \Throwable) {
$traces = $var->getTrace();
$dump = self::formatExceptionAsTrace($var);
} else {
$traces = debug_backtrace();
ob_start();
var_dump($var);
$dump = ob_get_clean();
}
// purge traces from skipped classes
$traces = array_filter(
$traces,
static fn($trace): bool
=> empty($trace['class']) || !in_array($trace['class'], self::$skip_classes)
);
$message = self::toHTML($dump, $var_name, $traces, $full_backtrace);
self::displayErrors($message);
return $var;
}
private static function formatExceptionAsTrace($var): string
{
return self::traceToString([
'class' => get_class($var),
'line' => $var->getLine(),
'file' => $var->getFile(),
'function' => 'getCode',
'args' => [$var->getCode()]
]) . PHP_EOL . $var->getMessage();
}
// should we display something ?
public static function displayErrors($error_message): void
{
if (empty($error_message)) {
return;
}
if (ini_get('display_errors') != '1') {
return;
}
echo $error_message;
}
// -- formatting
public static function toText($var_dump, $var_name, $backtrace, $full_backtrace): string
{
return PHP_EOL
. "******* "
. (empty($var_name) ? ($backtrace[1]['function'] ?? '?') . '()' : sprintf(' (%s) ', $var_name))
. " *******"
. PHP_EOL
. self::tracesToString($backtrace, $full_backtrace)
. PHP_EOL
. $var_dump;
}
public static function toHTML($var_dump, $var_name, $backtrace, $full_backtrace): string
{
$css = [
'text-align:left',
'z-index:9999',
'background-color:#FFF',
'color:#000',
'padding:0.5em',
'font-size:0.7em',
'margin:0 0 1em 0',
'font-family:courier'
];
return sprintf(
'<pre style="%s">%s</pre>',
implode(';', $css),
self::toText($var_dump, $var_name, $backtrace, $full_backtrace)
);
}
// reduce_file_depth_to allows for short filepath, cause it gets crazy sometimes
private static function formatFilename($file, $reduce_file_depth_to = 5): string
{
return implode('/', array_slice(explode('/', $file), -$reduce_file_depth_to, $reduce_file_depth_to));
}
// -- formatting : nice backtrace
private static function tracesToString($traces, $full_backtrace): string
{
$formated_traces = [];
foreach ($traces as $trace) {
$formated_traces [] = self::traceToString($trace);
if ($full_backtrace === false) {
break;
}
}
return implode(PHP_EOL, array_reverse($formated_traces));
}
private static function traceToString($trace): string
{
$function_name = $trace['function'] ?? '?';
$class_name = $trace['class'] ?? '';
if (self::isShortcutCall($function_name)) {
$args = date_format(date_create(), 'ymd:his');
} else {
$args = self::traceArgsToString($trace['args'] ?? []);
}
$call_file = isset($trace['file']) ? self::formatFilename($trace['file'], 2) : '?';
$call_line = $trace['line'] ?? '?';
return sprintf(
'[%-33.33s %3s] %s%s(%s)',
$call_file,
$call_line,
sprintf('%s::', $class_name),
$function_name,
$args
);
}
private static function traceArgsToString($trace_args): string
{
$ret = [];
foreach ($trace_args as $trace_arg) {
$ret[] = self::traceArgToString($trace_arg);
}
return implode(', ', $ret);
}
private static function traceArgToString($arg)
{
$ret = 'unknown type';
if (is_null($arg)) {
$ret = 'NULL';
} elseif (is_bool($arg)) {
$ret = '[bool]' . ((int)$arg);
} elseif (is_scalar($arg)) {
$ret = '[scalar]'.$arg;
} elseif (is_object($arg)) {
$ret = get_class($arg);
} elseif (is_array($arg)) {
$ret = 'Array #'.($count = count($arg)).($count>0 ? ' json:'.json_encode(array_keys($arg)) : '');
}
return $ret;
}
private static function isShortcutCall($function_name): bool
{
return in_array($function_name, ['vd', 'dd','vdt', 'ddt']);
}
}
}
namespace
{
use HexMakina\Debugger\Debugger;
if (!function_exists('vd')) {
function vd($var, $var_name = null): void
{
Debugger::visualDump($var, $var_name, false);
}
}
if (!function_exists('dd')) {
function dd($var, $var_name = null): void
{
Debugger::visualDump($var, $var_name, false);
die;
}
}
if (!function_exists('vdt')) {
function vdt($var, $var_name = null): void
{
Debugger::visualDump($var, $var_name, true);
}
}
if (!function_exists('ddt')) {
function ddt($var, $var_name = null): void
{
Debugger::visualDump($var, $var_name, true);
die;
}
}
}