Vperyod\ErrorlogHandler\ErrorlogHandler

Complexity

Total Complexity

9

Size/Duplication

Total Lines	158
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setLogLevel()	0	5	1
A	setRethrow()	0	5	1
A	__invoke()	0	12	3
A	formatResponse()	0	11	1
A	log()	0	8	1
A	formatException()	0	10	1

<?php
/**
 * Errorlog Handler
 *
 * PHP version 5
 *
 * Copyright (C) 2016 Jake Johns
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 *
 * @category  Middleware
 * @package   Vperyod\ErrorlogHandler
 * @author    Jake Johns <jake@jakejohns.net>
 * @copyright 2016 Jake Johns
 * @license   http://jnj.mit-license.org/2016 MIT License
 * @link      https://github.com/vperyod/vperyod.errorlog-handler
 */

namespace Vperyod\ErrorlogHandler;

use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;

use Psr\Log\LoggerInterface as Logger;
use Psr\Log\LogLevel as Level;

use Exception;

/**
 * ErrorlogHandler
 *
 * @category Middleware
 * @package  Vperyod\ErrorlogHandler
 * @author   Jake Johns <jake@jakejohns.net>
 * @license  http://jnj.mit-license.org/2016 MIT License
 * @link     https://github.com/vperyod/vperyod.errorlog-handler
 */
class ErrorlogHandler
{

    /**
     * Log
     *
     * @var Logger
     *
     * @access protected
     */
    protected $logger;

    /**
     * Rethrow exception?
     *
     * @var bool
     *
     * @access protected
     */
    protected $rethrow = true;

    /**
     * Level
     *
     * @var string
     *
     * @access protected
     */
    protected $level = Level::ALERT;

    /**
     * Create an ErrorlogHandler
     *
     * @param Logger $logger Psr\Log logger
     *
     * @access public
     */
    public function __construct(Logger $logger)
    {
        $this->logger = $logger;
    }

    /**
     * Set log level to use
     *
     * @param mixed $level Level to log exceptions
     *
     * @return $this
     *
     * @access public
     */
    public function setLogLevel($level)
    {
        $this->level = $level;
        return $this;
    }

    /**
     * Set if handler should retrhow exception
     *
     * @param bool $bool exception is re thrown if true
     *
     * @return $this
     *
     * @access public
     */
    public function setRethrow($bool)
    {
        $this->rethrow = (bool) $bool;
        return $this;
    }

    /**
     * Log an exception if thrown
     *
     * @param Request  $request  PSR7 HTTP Request
     * @param Response $response PSR7 HTTP Response
     * @param callable $next     Next callable middleware
     *
     * @return Response
     *
     * @access public
     *
     * @throws Exception throws caught exception if rethrow is true
     */
    public function __invoke(Request $request, Response $response, callable $next)
    {
        try {
            return $next($request, $response);
        } catch (Exception $exception) {
            $this->log($exception);
            if ($this->rethrow) {
                throw $exception;
            }
            return $this->formatResponse($exception, $response);
        }
    }

    /**
     * Log
     *
     * @param Exception $exception Exception to log
     *
     * @return void
     *
     * @access protected
     */
    protected function log(Exception $exception)
    {
        $this->logger->log(
            $this->level,
            $this->formatException($exception),
            ['exception' => $exception]
        );
    }

    /**
     * Format Exception into log message
     *
     * @param Exception $exception Exception to log
     *
     * @return string
     *
     * @access protected
     */
    protected function formatException(Exception $exception)
    {
        return sprintf(
            'Uncaught Exception %s: "%s" at %s line %s',
            get_class($exception),
            $exception->getMessage(),
            $exception->getFile(),
            $exception->getLine()
        );
    }

    /**
     * Format response to return
     *
     * @param Exception $exception Caught exception
     * @param Response  $response  Response object
     *
     * @return Response
     *
     * @access protected
     */
    protected function formatResponse(Exception $exception, Response $response)
    {
        $response = $response->withStatus(500)
            ->withHeader('Content-Type', 'text/plain; charset=utf-8');
        $response->getBody()->write(
            get_class($exception)
            . ': '
            . $exception->getMessage()
        );
        return $response;
    }
}