ErrorlogHandler::formatException() - Code Metrics - Inspection of "clean up" - vperyod/vperyod.errorlog-handler - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 95bf16...af59cb )

by jake

created 2016-03-31 22:00 UTC

ErrorlogHandler::formatException() A

↳ Parent: ErrorlogHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	10
ccs	8
cts	8
cp	1
rs	9.4285
cc	1
eloc	7
nc	1
nop	1
crap	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 <[email protected]>
 * @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 <[email protected]>
 * @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 $log;

    /**
     * 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;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /**
     * 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;
    }
}


1		<?php
2		/**
3		* Errorlog Handler
4		*
5		* PHP version 5
6		*
7		* Copyright (C) 2016 Jake Johns
8		*
9		* This software may be modified and distributed under the terms
10		* of the MIT license. See the LICENSE file for details.
11		*
12		* @category Middleware
13		* @package Vperyod\ErrorlogHandler
14		* @author Jake Johns <[email protected]>
15		* @copyright 2016 Jake Johns
16		* @license http://jnj.mit-license.org/2016 MIT License
17		* @link https://github.com/vperyod/vperyod.errorlog-handler
18		*/
19
20		namespace Vperyod\ErrorlogHandler;
21
22		use Psr\Http\Message\ResponseInterface as Response;
23		use Psr\Http\Message\ServerRequestInterface as Request;
24
25		use Psr\Log\LoggerInterface as Logger;
26		use Psr\Log\LogLevel as Level;
27
28		use Exception;
29
30		/**
31		* ErrorlogHandler
32		*
33		* @category Middleware
34		* @package Vperyod\ErrorlogHandler
35		* @author Jake Johns <[email protected]>
36		* @license http://jnj.mit-license.org/2016 MIT License
37		* @link https://github.com/vperyod/vperyod.errorlog-handler
38		*/
39		class ErrorlogHandler
40		{
41
42		/**
43		* Log
44		*
45		* @var Logger
46		*
47		* @access protected
48		*/
49		protected $log;
50
51		/**
52		* Rethrow exception?
53		*
54		* @var bool
55		*
56		* @access protected
57		*/
58		protected $rethrow = true;
59
60		/**
61		* Level
62		*
63		* @var string
64		*
65		* @access protected
66		*/
67		protected $level = Level::ALERT;
68
69		/**
70		* Create an ErrorlogHandler
71		*
72		* @param Logger $logger Psr\Log logger
73		*
74		* @access public
75		*/
76	4	public function __construct(Logger $logger)
77		{
78	4	$this->logger = $logger;
		0 ignored issues – show Bug introduced 2016-03-30 21:15 UTC by Report Bug Copy Issue Report The property `logger` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
79	4	}
80
81		/**
82		* Set log level to use
83		*
84		* @param mixed $level Level to log exceptions
85		*
86		* @return $this
87		*
88		* @access public
89		*/
90	1	public function setLogLevel($level)
91		{
92	1	$this->level = $level;
93	1	return $this;
94		}
95
96		/**
97		* Set if handler should retrhow exception
98		*
99		* @param bool $bool exception is re thrown if true
100		*
101		* @return $this
102		*
103		* @access public
104		*/
105	1	public function setRethrow($bool)
106		{
107	1	$this->rethrow = (bool) $bool;
108	1	return $this;
109		}
110
111		/**
112		* Log an exception if thrown
113		*
114		* @param Request $request PSR7 HTTP Request
115		* @param Response $response PSR7 HTTP Response
116		* @param callable $next Next callable middleware
117		*
118		* @return Response
119		*
120		* @access public
121		*
122		* @throws Exception throws caught exception if rethrow is true
123		*/
124	4	public function __invoke(Request $request, Response $response, callable $next)
125		{
126		try {
127	4	return $next($request, $response);
128	3	} catch (Exception $exception) {
129	3	$this->log($exception);
130	3	if ($this->rethrow) {
131	2	throw $exception;
132		}
133	1	return $this->formatResponse($exception, $response);
134		}
135		}
136
137		/**
138		* Log
139		*
140		* @param Exception $exception Exception to log
141		*
142		* @return void
143		*
144		* @access protected
145		*/
146	3	protected function log(Exception $exception)
147		{
148	3	$this->logger->log(
149	3	$this->level,
150	3	$this->formatException($exception),
151	3	['exception' => $exception]
152	3	);
153	3	}
154
155		/**
156		* Format Exception into log message
157		*
158		* @param Exception $exception Exception to log
159		*
160		* @return string
161		*
162		* @access protected
163		*/
164	3	protected function formatException(Exception $exception)
165		{
166	3	return sprintf(
167	3	'Uncaught Exception %s: "%s" at %s line %s',
168	3	get_class($exception),
169	3	$exception->getMessage(),
170	3	$exception->getFile(),
171	3	$exception->getLine()
172	3	);
173		}
174
175		/**
176		* Format response to return
177		*
178		* @param Exception $exception Caught exception
179		* @param Response $response Response object
180		*
181		* @return Response
182		*
183		* @access protected
184		*/
185	1	protected function formatResponse(Exception $exception, Response $response)
186		{
187	1	$response = $response->withStatus(500)
188	1	->withHeader('Content-Type', 'text/plain; charset=utf-8');
189	1	$response->getBody()->write(
190	1	get_class($exception)
191		. ': '
192	1	. $exception->getMessage()
193	1	);
194	1	return $response;
195		}
196		}
197

vperyod / vperyod.errorlog-handler

Push — develop ( 95bf16...af59cb )

ErrorlogHandler::formatException() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like