/**
* Formats a stack trace based on the supplied options.
*
* ### Options
*
* - `depth` - The number of stack frames to return. Defaults to 999
* - `format` - The format you want the return. Defaults to the currently selected format. If
* format is 'array' or 'points' the return will be an array.
* - `args` - Should arguments for functions be shown? If true, the arguments for each method call
* will be displayed.
* - `start` - The stack frame to start generating a trace from. Defaults to 0
*
* @param array|\Exception $backtrace Trace as array or an exception object.
* @param array $options Format for outputting stack trace.
* @return mixed Formatted stack trace.
* @link http://book.cakephp.org/3.0/en/development/debugging.html#generating-stack-traces
*/
public static function formatTrace($backtrace, $options = [])
{
if ($backtrace instanceof Exception) {
$backtrace = $backtrace->getTrace();
}
$self = Debugger::getInstance();
$defaults = ['depth' => 999, 'format' => $self->_outputFormat, 'args' => false, 'start' => 0, 'scope' => null, 'exclude' => ['call_user_func_array', 'trigger_error']];
$options = ArrayObject::fromArray($defaults)->merge($options);
$count = count($backtrace);
$back = [];
$_trace = ['line' => '??', 'file' => '[internal]', 'class' => null, 'function' => '[main]'];
for ($i = $options['start']; $i < $count && $i < $options['depth']; $i++) {
$trace = $backtrace[$i] + ['file' => '[internal]', 'line' => '??'];
$signature = $reference = '[main]';
if (isset($backtrace[$i + 1])) {
$next = $backtrace[$i + 1] + $_trace;
$signature = $reference = $next['function'];
if (!empty($next['class'])) {
$signature = $next['class'] . '::' . $next['function'];
$reference = $signature . '(';
if ($options['args'] && isset($next['args'])) {
$args = [];
foreach ($next['args'] as $arg) {
$args[] = Debugger::exportVar($arg);
}
$reference .= implode(', ', $args);
}
$reference .= ')';
}
}
if (in_array($signature, $options['exclude'])) {
continue;
}
if ($options['format'] === 'points' && $trace['file'] !== '[internal]') {
$back[] = ['file' => $trace['file'], 'line' => $trace['line']];
} elseif ($options['format'] === 'array') {
$back[] = $trace;
} else {
if (isset($self->_templates[$options['format']]['traceLine'])) {
$tpl = $self->_templates[$options['format']]['traceLine'];
} else {
$tpl = $self->_templates['base']['traceLine'];
}
$trace['path'] = static::trimPath($trace['file']);
$trace['reference'] = $reference;
unset($trace['object'], $trace['args']);
(new Text($tpl))->insert($trace);
$back[] = (new Text($tpl))->insert($trace);
}
}
if ($options['format'] === 'array' || $options['format'] === 'points') {
return $back;
}
return implode("\n", $back);
}
