Completed
Push — dev-master ( f1d44b...511541 )
by Derek Stephen
01:34
created

PlatesStrategy::getResponseWithBodyAndStatus()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 8

Duplication

Lines 8
Ratio 100 %

Code Coverage

Tests 5
CRAP Score 1

Importance

Changes 0
Metric Value
dl 8
loc 8
ccs 5
cts 5
cp 1
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 3
crap 1
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};
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Bone\Mvc\Router\NotFoundException.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
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 Laminas\Diactoros\Response;
19
use Laminas\Diactoros\Response\HtmlResponse;
20
use Laminas\Diactoros\Response\JsonResponse;
21
use Laminas\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 9
    public function __construct(PlatesEngine $viewEngine, NotFoundDecorator $notFound, NotAllowedDecorator $notAllowed, string $layout, ExceptionDecorator $exceptionDecorator)
53
    {
54 9
        $this->viewEngine = $viewEngine;
55 9
        $this->notFoundDecorator = $notFound;
56 9
        $this->notAllowedDecorator = $notAllowed;
57 9
        $this->exceptionDecorator = $exceptionDecorator;
58 9
        $this->setLayout($layout);
59 9
    }
60
61
    /**
62
     * @param bool $i18nEnabled
63
     */
64 8
    public function setI18nEnabled(bool $i18nEnabled): void
65
    {
66 8
        $this->i18nEnabled = $i18nEnabled;
67 8
    }
68
69
    /**
70
     * @param array $locales
71
     */
72 8
    public function setSupportedLocales(array $locales): void
73
    {
74 8
        $this->supportedLocales = $locales;
75 8
    }
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 5
    public function invokeRouteCallable(Route $route, ServerRequestInterface $request): ResponseInterface
87
    {
88
        try {
89
90 5
            $response = parent::invokeRouteCallable($route, $request);
91 4
            if ($response instanceof JsonResponse) {
92 2
                return $response;
93
            }
94
95 2
            $body = ['content' => $response->getBody()->getContents()];
96 2
            $body = $this->viewEngine->render($this->layout, $body);
97
98 2
            return $this->getResponseWithBodyAndStatus($response, $body, $response->getStatusCode());
0 ignored issues
show
Compatibility introduced by
$response of type object<Psr\Http\Message\ResponseInterface> is not a sub-type of object<Laminas\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 1
        } catch (Exception $e) {
101 1
            $body = $this->viewEngine->render('error/error', [
102 1
                'message' => $e->getMessage(),
103 1
                'code' => $e->getCode(),
104 1
                'trace' => $e->getTrace(),
105
            ]);
106 1
            $body = $this->viewEngine->render($this->layout, [
107 1
                'content' => $body,
108
            ]);
109 1
            $status = ($e->getCode() >= 100 && $e->getCode() < 600) ? $e->getCode() : 500;
110
111 1
            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 3 View Code Duplication
    private function getResponseWithBodyAndStatus(Response $response, string $body, int $status = 200)
0 ignored issues
show
Duplication introduced by
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 3
        $stream = new Stream('php://memory', 'r+');
125 3
        $stream->write($body);
126 3
        $response = $response->withStatus($status)->withBody($stream);
127
128 3
        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 by
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 1
    public function getNotFoundDecorator(NotFoundException $e): MiddlewareInterface
139
    {
140 1
        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 1
    public function getMethodNotAllowedDecorator(MethodNotAllowedException $e): MiddlewareInterface
151
    {
152 1
        return $this->notAllowedDecorator;
153
    }
154
155
    /**
156
     * @return MiddlewareInterface
157
     */
158 5
    public function getExceptionHandler(): MiddlewareInterface
159
    {
160 5
        return $this->exceptionDecorator;
161
    }
162
}