PlatesStrategy::getExceptionHandler() - Code Metrics - Inspection of "session aware interface and has session trait" - delboy1978uk/bone - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 753e69...36642f )

by Derek Stephen

created 2019-10-26 21:17 UTC

PlatesStrategy::getExceptionHandler() A

↳ Parent: PlatesStrategy

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

namespace Bone\Mvc\Router;

use Bone\Mvc\Router\Decorator\ExceptionDecorator;
use Bone\Mvc\Router\Decorator\NotAllowedDecorator;
use Bone\Mvc\Router\Decorator\NotFoundDecorator;
use Bone\Mvc\View\PlatesEngine;
use Bone\Traits\HasLayoutTrait;
use Exception;
use League\Route\Http\Exception\{MethodNotAllowedException, NotFoundException};
use League\Route\Route;
use League\Route\Strategy\ApplicationStrategy;
use League\Route\Strategy\StrategyInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\MiddlewareInterface;
use Zend\Diactoros\Response;
use Zend\Diactoros\Response\HtmlResponse;
use Zend\Diactoros\Response\JsonResponse;
use Zend\Diactoros\Stream;

class PlatesStrategy extends ApplicationStrategy implements StrategyInterface
{
    use HasLayoutTrait;

    /** @var PlatesEngine $viewEngine */
    private $viewEngine;

    /** @var NotFoundDecorator $notFoundDecorator */
    private $notFoundDecorator;

    /** @var NotAllowedDecorator $notAllowedDecorator */
    private $notAllowedDecorator;

    /** @var ExceptionDecorator $exceptionDecorator */
    private $exceptionDecorator;

    /** @var bool  */
    private $i18nEnabled = false;

    /** @var array  */
    private $supportedLocales = [];

    /**
     * PlatesStrategy constructor.
     * @param PlatesEngine $viewEngine
     * @param NotFoundDecorator $notFound
     * @param NotAllowedDecorator $notAllowed
     * @param string $layout
     */
    public function __construct(PlatesEngine $viewEngine, NotFoundDecorator $notFound, NotAllowedDecorator $notAllowed, string $layout, ExceptionDecorator $exceptionDecorator)
    {
        $this->viewEngine = $viewEngine;
        $this->notFoundDecorator = $notFound;
        $this->notAllowedDecorator = $notAllowed;
        $this->exceptionDecorator = $exceptionDecorator;
        $this->setLayout($layout);
    }

    /**
     * @param bool $i18nEnabled
     */
    public function setI18nEnabled(bool $i18nEnabled): void
    {
        $this->i18nEnabled = $i18nEnabled;
    }

    /**
     * @param array $locales
     */
    public function setSupportedLocales(array $locales): void
    {
        $this->supportedLocales = $locales;
    }


    /**
     * Invoke the route callable based on the strategy.
     *
     * @param \League\Route\Route $route
     * @param \Psr\Http\Message\ServerRequestInterface $request
     *
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function invokeRouteCallable(Route $route, ServerRequestInterface $request): ResponseInterface
    {
        try {

            $response = parent::invokeRouteCallable($route, $request);
            if ($response instanceof JsonResponse) {
                return $response;
            }

            $body = ['content' => $response->getBody()->getContents()];
            $body = $this->viewEngine->render($this->layout, $body);

            return $this->getResponseWithBodyAndStatus($response, $body, $response->getStatusCode());


        } catch (Exception $e) {
            $body = $this->viewEngine->render('error/error', [
                'message' => $e->getMessage(),
                'code' => $e->getCode(),
                'trace' => $e->getTrace(),
            ]);
            $body = $this->viewEngine->render($this->layout, [
                'content' => $body,
            ]);
            $status = ($e->getCode() >= 100 && $e->getCode() < 600) ? $e->getCode() : 500;

            return $this->getResponseWithBodyAndStatus(new HtmlResponse($body), $body, $status);
        }

    }

    /**
     * @param ResponseInterface $response
     * @param string $body
     * @param int $status
     * @return \Psr\Http\Message\MessageInterface|Response
     */
    private function getResponseWithBodyAndStatus(Response $response, string $body, int $status = 200)

    {
        $stream = new Stream('php://memory', 'r+');
        $stream->write($body);
        $response = $response->withStatus($status)->withBody($stream);

        return $response;
    }

    /**
     * Get a middleware that will decorate a NotFoundException
     *
     * @param \League\Route\Http\Exception\NotFoundException $exception
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \Psr\Http\Server\MiddlewareInterface
     */
    public function getNotFoundDecorator(NotFoundException $e): MiddlewareInterface
    {
        return $this->notFoundDecorator;
    }

    /**
     * Get a middleware that will decorate a NotAllowedException
     *
     * @param \League\Route\Http\Exception\NotFoundException $e
     *
     * @return \Psr\Http\Server\MiddlewareInterface
     */
    public function getMethodNotAllowedDecorator(MethodNotAllowedException $e): MiddlewareInterface
    {
        return $this->notAllowedDecorator;
    }

    /**
     * @return MiddlewareInterface
     */
    public function getExceptionHandler(): MiddlewareInterface
    {
        return $this->exceptionDecorator;
    }
}

1		<?php
2
3		namespace Bone\Mvc\Router;
4
5		use Bone\Mvc\Router\Decorator\ExceptionDecorator;
6		use Bone\Mvc\Router\Decorator\NotAllowedDecorator;
7		use Bone\Mvc\Router\Decorator\NotFoundDecorator;
8		use Bone\Mvc\View\PlatesEngine;
9		use Bone\Traits\HasLayoutTrait;
10		use Exception;
11		use League\Route\Http\Exception\{MethodNotAllowedException, NotFoundException};
12		use League\Route\Route;
13		use League\Route\Strategy\ApplicationStrategy;
14		use League\Route\Strategy\StrategyInterface;
15		use Psr\Http\Message\ResponseInterface;
16		use Psr\Http\Message\ServerRequestInterface;
17		use Psr\Http\Server\MiddlewareInterface;
18		use Zend\Diactoros\Response;
19		use Zend\Diactoros\Response\HtmlResponse;
20		use Zend\Diactoros\Response\JsonResponse;
21		use Zend\Diactoros\Stream;
22
23		class PlatesStrategy extends ApplicationStrategy implements StrategyInterface
24		{
25		use HasLayoutTrait;
26
27		/** @var PlatesEngine $viewEngine */
28		private $viewEngine;
29
30		/** @var NotFoundDecorator $notFoundDecorator */
31		private $notFoundDecorator;
32
33		/** @var NotAllowedDecorator $notAllowedDecorator */
34		private $notAllowedDecorator;
35
36		/** @var ExceptionDecorator $exceptionDecorator */
37		private $exceptionDecorator;
38
39		/** @var bool */
40		private $i18nEnabled = false;
41
42		/** @var array */
43		private $supportedLocales = [];
44
45		/**
46		* PlatesStrategy constructor.
47		* @param PlatesEngine $viewEngine
48		* @param NotFoundDecorator $notFound
49		* @param NotAllowedDecorator $notAllowed
50		* @param string $layout
51		*/
52		public function __construct(PlatesEngine $viewEngine, NotFoundDecorator $notFound, NotAllowedDecorator $notAllowed, string $layout, ExceptionDecorator $exceptionDecorator)
53		{
54		$this->viewEngine = $viewEngine;
55		$this->notFoundDecorator = $notFound;
56		$this->notAllowedDecorator = $notAllowed;
57		$this->exceptionDecorator = $exceptionDecorator;
58		$this->setLayout($layout);
59		}
60
61		/**
62		* @param bool $i18nEnabled
63		*/
64		public function setI18nEnabled(bool $i18nEnabled): void
65		{
66		$this->i18nEnabled = $i18nEnabled;
67		}
68
69		/**
70		* @param array $locales
71		*/
72		public function setSupportedLocales(array $locales): void
73		{
74		$this->supportedLocales = $locales;
75		}
76
77
78		/**
79		* Invoke the route callable based on the strategy.
80		*
81		* @param \League\Route\Route $route
82		* @param \Psr\Http\Message\ServerRequestInterface $request
83		*
84		* @return \Psr\Http\Message\ResponseInterface
85		*/
86		public function invokeRouteCallable(Route $route, ServerRequestInterface $request): ResponseInterface
87		{
88		try {
89
90		$response = parent::invokeRouteCallable($route, $request);
91		if ($response instanceof JsonResponse) {
92		return $response;
93		}
94
95		$body = ['content' => $response->getBody()->getContents()];
96		$body = $this->viewEngine->render($this->layout, $body);
97
98		return $this->getResponseWithBodyAndStatus($response, $body, $response->getStatusCode());
		0 ignored issues – show Compatibility introduced 2019-09-16 01:21 UTC by Report Bug Copy Issue Report `$response` of type `object<Psr\Http\Message\ResponseInterface>` is not a sub-type of `object<Zend\Diactoros\Response>`. It seems like you assume a concrete implementation of the interface `Psr\Http\Message\ResponseInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
99
100		} catch (Exception $e) {
101		$body = $this->viewEngine->render('error/error', [
102		'message' => $e->getMessage(),
103		'code' => $e->getCode(),
104		'trace' => $e->getTrace(),
105		]);
106		$body = $this->viewEngine->render($this->layout, [
107		'content' => $body,
108		]);
109		$status = ($e->getCode() >= 100 && $e->getCode() < 600) ? $e->getCode() : 500;
110
111		return $this->getResponseWithBodyAndStatus(new HtmlResponse($body), $body, $status);
112		}
113
114		}
115
116		/**
117		* @param ResponseInterface $response
118		* @param string $body
119		* @param int $status
120		* @return \Psr\Http\Message\MessageInterface\|Response
121		*/
122	View Code Duplication	private function getResponseWithBodyAndStatus(Response $response, string $body, int $status = 200)
		0 ignored issues – show Duplication introduced 2019-10-26 21:19 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		{
124		$stream = new Stream('php://memory', 'r+');
125		$stream->write($body);
126		$response = $response->withStatus($status)->withBody($stream);
127
128		return $response;
129		}
130
131		/**
132		* Get a middleware that will decorate a NotFoundException
133		*
134		* @param \League\Route\Http\Exception\NotFoundException $exception
		0 ignored issues – show Bug introduced 2019-09-16 01:21 UTC by Report Bug Copy Issue Report There is no parameter named `$exception`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
135		*
136		* @return \Psr\Http\Server\MiddlewareInterface
137		*/
138		public function getNotFoundDecorator(NotFoundException $e): MiddlewareInterface
139		{
140		return $this->notFoundDecorator;
141		}
142
143		/**
144		* Get a middleware that will decorate a NotAllowedException
145		*
146		* @param \League\Route\Http\Exception\NotFoundException $e
147		*
148		* @return \Psr\Http\Server\MiddlewareInterface
149		*/
150		public function getMethodNotAllowedDecorator(MethodNotAllowedException $e): MiddlewareInterface
151		{
152		return $this->notAllowedDecorator;
153		}
154
155		/**
156		* @return MiddlewareInterface
157		*/
158		public function getExceptionHandler(): MiddlewareInterface
159		{
160		return $this->exceptionDecorator;
161		}
162		}

delboy1978uk / bone

Push — master ( 753e69...36642f )

PlatesStrategy::getExceptionHandler() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like