[TASK] Streamline PHPDoc comment matches function/method signature
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Error / Http / StatusException.php
1 <?php
2 namespace TYPO3\CMS\Core\Error\Http;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * HTTP Status Exception
19 */
20 class StatusException extends \TYPO3\CMS\Core\Error\Exception
21 {
22 /**
23 * @var array HTTP Status Header lines
24 */
25 protected $statusHeaders;
26
27 /**
28 * @var string Title of the message
29 */
30 protected $title = 'Oops, an error occurred!';
31
32 /**
33 * Constructor for this Status Exception
34 *
35 * @param string|array $statusHeaders HTTP Status header line(s)
36 * @param string $title Title of the error message
37 * @param string $message Error Message
38 * @param int $code Exception Code
39 */
40 public function __construct($statusHeaders, $message, $title = '', $code = 0)
41 {
42 if (is_array($statusHeaders)) {
43 $this->statusHeaders = $statusHeaders;
44 } else {
45 $this->statusHeaders = [$statusHeaders];
46 }
47 $this->title = $title ?: $this->title;
48 parent::__construct($message, $code);
49 }
50
51 /**
52 * Setter for the title.
53 *
54 * @param string $title
55 */
56 public function setTitle($title)
57 {
58 $this->title = $title;
59 }
60
61 /**
62 * Getter for the title.
63 *
64 * @return string
65 */
66 public function getTitle()
67 {
68 return $this->title;
69 }
70
71 /**
72 * Getter for the Status Header.
73 *
74 * @return array
75 */
76 public function getStatusHeaders()
77 {
78 return $this->statusHeaders;
79 }
80 }