Viewing file:  ExceptionsCollector.php (7.21 KB) -rw-rw-rw-
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* This file is part of the DebugBar package.
*
* (c) 2013 Maxime Bouroumeau-Fuseau
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace DebugBar\DataCollector;
use Throwable;
use Symfony\Component\Debug\Exception\FatalThrowableError;
/**
* Collects info about exceptions
*/
class ExceptionsCollector extends DataCollector implements Renderable
{
protected $exceptions = array();
protected $chainExceptions = false;
/**
* Adds an exception to be profiled in the debug bar
*
* @param \Exception $e
* @deprecated in favor on addThrowable
*/
public function addException(\Exception $e)
{
$this->addThrowable($e);
}
/**
* Adds a Throwable to be profiled in the debug bar
*
* @param Throwable $e
*/
public function addThrowable($e)
{
$this->exceptions[] = $e;
if ($this->chainExceptions && $previous = $e->getPrevious()) {
$this->addThrowable($previous);
}
}
/**
* Configure whether or not all chained exceptions should be shown.
*
* @param bool $chainExceptions
*/
public function setChainExceptions($chainExceptions = true)
{
$this->chainExceptions = $chainExceptions;
}
/**
* Start collecting warnings, notices and deprecations
*
* @param bool $preserveOriginalHandler
*/
public function collectWarnings($preserveOriginalHandler = true) {
$self = $this;
$originalHandler = $preserveOriginalHandler ? set_error_handler(null) : null;
set_error_handler(function ($errno, $errstr, $errfile, $errline) use ($self, $originalHandler) {
$self->addWarning($errno, $errstr, $errfile, $errline);
if ($originalHandler) {
return call_user_func($originalHandler, $errno, $errstr, $errfile, $errline);
}
return false;
});
}
/**
* Adds an warning to be profiled in the debug bar
*
* @param int $errno
* @param string $errstr
* @param string $errfile
* @param int $errline
* @return void
*/
public function addWarning($errno, $errstr, $errfile = '', $errline = 0)
{
$errorTypes = array(
1 => 'E_ERROR',
2 => 'E_WARNING',
4 => 'E_PARSE',
8 => 'E_NOTICE',
16 => 'E_CORE_ERROR',
32 => 'E_CORE_WARNING',
64 => 'E_COMPILE_ERROR',
128 => 'E_COMPILE_WARNING',
256 => 'E_USER_ERROR',
512 => 'E_USER_WARNING',
1024 => 'E_USER_NOTICE',
2048 => 'E_STRICT',
4096 => 'E_RECOVERABLE_ERROR',
8192 => 'E_DEPRECATED',
16384 => 'E_USER_DEPRECATED'
);
$this->exceptions[] = array(
'type' => $errorTypes[$errno] ?? 'UNKNOWN',
'message' => $errstr,
'code' => $errno,
'file' => $this->normalizeFilePath($errfile),
'line' => $errline,
'xdebug_link' => $this->getXdebugLink($errfile, $errline)
);
}
/**
* Returns the list of exceptions being profiled
*
* @return array<Throwable|array>
*/
public function getExceptions()
{
return $this->exceptions;
}
public function collect()
{
return array(
'count' => count($this->exceptions),
'exceptions' => array_map(array($this, 'formatThrowableData'), $this->exceptions)
);
}
/**
* Returns exception data as an array
*
* @param \Exception $e
* @return array
* @deprecated in favor on formatThrowableData
*/
public function formatExceptionData(\Exception $e)
{
return $this->formatThrowableData($e);
}
/**
* Returns Throwable trace as an formated array
*
* @return array
*/
public function formatTrace(array $trace)
{
if (! empty($this->xdebugReplacements)) {
$trace = array_map(function ($track) {
if (isset($track['file'])) {
$track['file'] = $this->normalizeFilePath($track['file']);
}
return $track;
}, $trace);
}
// Remove large objects from the trace
$trace = array_map(function ($track) {
if (isset($track['args'])) {
foreach ($track['args'] as $key => $arg) {
if (is_object($arg)) {
$track['args'][$key] = '[object ' . $this->getDataFormatter()->formatClassName($arg) . ']';
}
}
}
return $track;
}, $trace);
return $trace;
}
/**
* Returns Throwable data as an string
*
* @param Throwable $e
* @return string
*/
public function formatTraceAsString($e)
{
if (! empty($this->xdebugReplacements)) {
return implode("\n", array_map(function ($track) {
$track = explode(' ', $track);
if (isset($track[1])) {
$track[1] = $this->normalizeFilePath($track[1]);
}
return implode(' ', $track);
}, explode("\n", $e->getTraceAsString())));
}
return $e->getTraceAsString();
}
/**
* Returns Throwable data as an array
*
* @param Throwable|array $e
* @return array
*/
public function formatThrowableData($e)
{
if (is_array($e)) {
return $e;
}
$filePath = $e->getFile();
if ($filePath && file_exists($filePath)) {
$lines = file($filePath);
$start = $e->getLine() - 4;
$lines = array_slice($lines, $start < 0 ? 0 : $start, 7);
} else {
$lines = array('Cannot open the file ('.$this->normalizeFilePath($filePath).') in which the exception occurred');
}
$traceHtml = null;
if ($this->isHtmlVarDumperUsed()) {
$traceHtml = $this->getVarDumper()->renderVar($this->formatTrace($e->getTrace()));
}
return array(
'type' => get_class($e),
'message' => $e->getMessage(),
'code' => $e->getCode(),
'file' => $this->normalizeFilePath($filePath),
'line' => $e->getLine(),
'stack_trace' => $traceHtml ? null : $this->formatTraceAsString($e),
'stack_trace_html' => $traceHtml,
'surrounding_lines' => $lines,
'xdebug_link' => $this->getXdebugLink($filePath, $e->getLine())
);
}
/**
* @return string
*/
public function getName()
{
return 'exceptions';
}
/**
* @return array
*/
public function getWidgets()
{
return array(
'exceptions' => array(
'icon' => 'bug',
'widget' => 'PhpDebugBar.Widgets.ExceptionsWidget',
'map' => 'exceptions.exceptions',
'default' => '[]'
),
'exceptions:badge' => array(
'map' => 'exceptions.count',
'default' => 'null'
)
);
}
}
|