summaryrefslogtreecommitdiffstats
path: root/library/Icinga/Exception/Http/BaseHttpException.php
blob: cad41c622d00cce922e014fd1f861fb89a33935d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
<?php
/* Icinga Web 2 | (c) 2017 Icinga Development Team | GPLv2+ */

namespace Icinga\Exception\Http;

use Icinga\Exception\IcingaException;

/**
 * Base class for HTTP exceptions
 */
class BaseHttpException extends IcingaException implements HttpExceptionInterface
{
    /**
     * This exception's HTTP status code
     *
     * @var int
     */
    protected $statusCode;

    /**
     * This exception's HTTP response headers
     *
     * @var array
     */
    protected $headers;

    /**
     * Return this exception's HTTP status code
     *
     * @return int
     */
    public function getStatusCode()
    {
        return $this->statusCode;
    }

    /**
     * Set this exception's HTTP response headers
     *
     * @param   array   $headers
     *
     * @return  $this
     */
    public function setHeaders(array $headers)
    {
        $this->headers = $headers;
        return $this;
    }

    /**
     * Set/Add a HTTP response header
     *
     * @param   string  $name
     * @param   string  $value
     *
     * @return  $this
     */
    public function setHeader($name, $value)
    {
        $this->headers[$name] = $value;
        return $this;
    }

    /**
     * Return this exception's HTTP response headers
     *
     * @return array    An array where each key is a header name and the value its value
     */
    public function getHeaders()
    {
        return $this->headers ?: array();
    }
}