PeekAndPoke\Component\Toolbox\ExceptionUtil

Complexity

Total Complexity

11

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	toLines()	0	3	1
A	toRaw()	0	4	1
A	formatMessage()	0	3	1
A	warn()	0	7	1
A	toReducedArray()	0	39	3
A	info()	0	7	1
A	toString()	0	7	1
A	log()	0	10	2

<?php

namespace PeekAndPoke\Component\Toolbox;

use Psr\Log\LoggerInterface;

/**
 * @author Karsten J. Gerber <kontakt@karsten-gerber.de>
 *
 * @codeCoverageIgnore
 */
class ExceptionUtil
{
    /**
     * @param \Throwable $e
     *
     * @return string
     */
    public static function toString(\Throwable $e)
    {
        // use internal exception printing
        ob_start();
        echo (string) $e;

        return ob_get_clean();
    }

    /**
     * @param \Throwable $e
     *
     * @return string[]
     */
    public static function toLines(\Throwable $e)
    {
        return explode("\n", self::toString($e));
    }

    /**
     * @param LoggerInterface $logger
     * @param \Throwable      $e
     * @param string          $prefix
     * @param array           $extra
     */
    public static function log(LoggerInterface $logger, \Throwable $e, $prefix, array $extra = [])
    {
        $result = static::toString($e);

        $extra['exception'] = $result;

        if ($e instanceof \ErrorException) {
            $logger->alert($prefix . ' ' . static::formatMessage($e), $extra);
        } else {
            $logger->error($prefix . ' ' . static::formatMessage($e), $extra);
        }
    }

    /**
     * @param LoggerInterface $logger
     * @param \Throwable      $e
     * @param string          $prefix
     * @param array           $extra
     */
    public static function warn(LoggerInterface $logger, \Throwable $e, $prefix, array $extra = [])
    {
        $result = static::toString($e);

        $extra['exception'] = $result;

        $logger->warning($prefix . ' ' . static::formatMessage($e), $extra);
    }

    /**
     * @param LoggerInterface $logger
     * @param \Throwable      $e
     * @param string          $prefix
     * @param array           $extra
     */
    public static function info(LoggerInterface $logger, \Throwable $e, $prefix, array $extra = [])
    {
        $result = static::toString($e);

        $extra['exception'] = $result;

        $logger->info($prefix . ' ' . static::formatMessage($e), $extra);
    }

    /**
     * @param \Throwable $e
     *
     * @return array
     */
    public static function toRaw(\Throwable $e)
    {
        return [
            'raw' => explode(PHP_EOL, static::toString($e)),
        ];
    }

    /**
     * @param \Throwable $e
     *
     * @return array
     */
    public static function toReducedArray(\Throwable $e)
    {
        $originalException = $e;

        $renderedTrace = [];

        while ($e) {

            $trace                = $e->getTrace();
            $currentRenderedTrace = [];

            $idx = 0;

            foreach ($trace as $traceItem) {

                $currentRenderedTrace['#' . $idx++] =
                    ($traceItem['file'] ?? '') . '(' .
                    ($traceItem['line'] ?? '') . ') ' .
                    ($traceItem['class'] ?? '') .
                    ($traceItem['type'] ?? '') .
                    ($traceItem['function'] ?? '');
            }

            $renderedTrace[] = [
                'ex'      => \get_class($e),
                'message' => static::formatMessage($e),
                'trace'   => $currentRenderedTrace,
            ];

            $e = $e->getPrevious();
        }

        $json = [
            'ex'      => \get_class($originalException),
            'message' => static::formatMessage($originalException),
            'trace'   => $renderedTrace,
        ];

        return $json;
    }

    /**
     * @param \Throwable $e
     *
     * @return string
     */
    public static function formatMessage(\Throwable $e)
    {
        return $e->getMessage() . ' (Code ' . $e->getCode() . ') at ' . $e->getFile() . ':' . $e->getLine();
    }
}