Completed
Push — master ( 524f82...7dba56 )
by Oscar
04:14
created

RedirectTrait::getRedirectResponse()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 1 Features 0
Metric Value
c 2
b 1
f 0
dl 0
loc 7
rs 9.4286
cc 1
eloc 5
nc 1
nop 3
1
<?php
2
3
namespace Psr7Middlewares\Utils;
4
5
use Psr7Middlewares\Middleware;
6
use Psr\Http\Message\ResponseInterface;
7
use Psr\Http\Message\UriInterface;
8
use InvalidArgumentException;
9
10
/**
11
 * Trait used by all middlewares with redirect() option.
12
 */
13
trait RedirectTrait
14
{
15
    /** 
16
     * @var int Redirect HTTP status code
17
     */
18
    protected $redirectStatus;
19
20
    /**
21
     * Set HTTP redirect status code.
22
     *
23
     * @param int $redirectStatus Redirect HTTP status code
24
     * 
25
     * @return self
26
     */
27
    public function redirect($redirectStatus = 302)
28
    {
29
        if (!in_array($redirectStatus, [301, 302], true)) {
30
            throw new InvalidArgumentException('The redirect status code must be 301 or 302');
31
        }
32
33
        $this->redirectStatus = $redirectStatus;
34
35
        return $this;
36
    }
37
38
    /**
39
     * Returns a redirect response.
40
     * 
41
     * @param int               $redirectStatus
42
     * @param UriInterface      $uri
43
     * @param ResponseInterface $response
44
     */
45
    protected static function getRedirectResponse($redirectStatus, UriInterface $uri, ResponseInterface $response)
46
    {
47
        return $response
48
            ->withStatus($redirectStatus)
49
            ->withHeader('Location', (string) $uri)
50
            ->withBody(Middleware::createStream());
51
    }
52
}
53