|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace DF\PHPCoverFish\Common; |
|
4
|
|
|
|
|
5
|
|
|
/** |
|
6
|
|
|
* Class CoverFishMessage, code coverage error definition |
|
7
|
|
|
* |
|
8
|
|
|
* @package DF\PHPCoverFish |
|
9
|
|
|
* @author Patrick Paechnatz <[email protected]> |
|
10
|
|
|
* @copyright 2015 Patrick Paechnatz <[email protected]> |
|
11
|
|
|
* @license http://www.opensource.org/licenses/MIT |
|
12
|
|
|
* @link http://github.com/dunkelfrosch/phpcoverfish/tree |
|
13
|
|
|
* @since class available since Release 0.9.9 |
|
14
|
|
|
* @version 1.0.0 |
|
15
|
|
|
*/ |
|
16
|
|
|
class CoverFishMessage |
|
17
|
|
|
{ |
|
18
|
|
|
/** |
|
19
|
|
|
* @var array |
|
20
|
|
|
*/ |
|
21
|
|
|
public $messageTokens; |
|
22
|
|
|
|
|
23
|
|
|
/** |
|
24
|
|
|
* @var int |
|
25
|
|
|
*/ |
|
26
|
|
|
private $messageCode = 0; |
|
27
|
|
|
|
|
28
|
|
|
/** |
|
29
|
|
|
* @var string |
|
30
|
|
|
*/ |
|
31
|
|
|
private $messageTitle = null; |
|
32
|
|
|
|
|
33
|
|
|
/** |
|
34
|
|
|
* @var string |
|
35
|
|
|
*/ |
|
36
|
|
|
private $messageToken = null; |
|
37
|
|
|
|
|
38
|
|
|
/** |
|
39
|
|
|
* @var string |
|
40
|
|
|
*/ |
|
41
|
|
|
private $exceptionMessage = null; |
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* @param int $messageCode |
|
45
|
|
|
* @param null|string $exceptionMessage |
|
46
|
|
|
* |
|
47
|
|
|
* @throws \Exception |
|
48
|
|
|
*/ |
|
49
|
|
|
public function __construct($messageCode = 0, $exceptionMessage = null) |
|
50
|
|
|
{ |
|
51
|
|
|
$this->messageCode = $messageCode; |
|
52
|
|
|
$this->exceptionMessage = $exceptionMessage; |
|
53
|
|
|
$this->messageToken = 'Unknown Message-Code!'; |
|
54
|
|
|
|
|
55
|
|
|
if ($messageCode !== 0) { |
|
56
|
|
|
if (!isset($this->messageTokens[$messageCode])) { |
|
57
|
|
|
throw new \Exception(sprintf( |
|
58
|
|
|
'MessageCode found but no title for type "%s" declared. Did you define this specific message code in your message token?', |
|
59
|
|
|
$messageCode |
|
60
|
|
|
)); |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
$this->messageTitle = $this->messageTokens[$messageCode]; |
|
64
|
|
|
$this->messageToken = $this->messageTitle; |
|
65
|
|
|
} |
|
66
|
|
|
} |
|
67
|
|
|
|
|
68
|
|
|
/** |
|
69
|
|
|
* @return int |
|
70
|
|
|
*/ |
|
71
|
|
|
public function getMessageCode() |
|
72
|
|
|
{ |
|
73
|
|
|
return $this->messageCode; |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
/** |
|
77
|
|
|
* @codeCoverageIgnore |
|
78
|
|
|
* |
|
79
|
|
|
* @param int $messageCode |
|
80
|
|
|
*/ |
|
81
|
|
|
public function setMessageCode($messageCode) |
|
82
|
|
|
{ |
|
83
|
|
|
$this->messageCode = $messageCode; |
|
84
|
|
|
} |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* @return string |
|
88
|
|
|
*/ |
|
89
|
|
|
public function getMessageTitle() |
|
90
|
|
|
{ |
|
91
|
|
|
return $this->messageTitle; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
/** |
|
95
|
|
|
* @codeCoverageIgnore |
|
96
|
|
|
* |
|
97
|
|
|
* @param string $messageTitle |
|
98
|
|
|
*/ |
|
99
|
|
|
public function setMessageTitle($messageTitle) |
|
100
|
|
|
{ |
|
101
|
|
|
$this->messageTitle = $messageTitle; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* @return string |
|
106
|
|
|
*/ |
|
107
|
|
|
public function getMessageToken() |
|
108
|
|
|
{ |
|
109
|
|
|
return $this->messageToken; |
|
110
|
|
|
} |
|
111
|
|
|
|
|
112
|
|
|
/** |
|
113
|
|
|
* @codeCoverageIgnore |
|
114
|
|
|
* |
|
115
|
|
|
* @param string $messageToken |
|
116
|
|
|
*/ |
|
117
|
|
|
public function setMessageToken($messageToken) |
|
118
|
|
|
{ |
|
119
|
|
|
$this->messageToken = $messageToken; |
|
120
|
|
|
} |
|
121
|
|
|
|
|
122
|
|
|
/** |
|
123
|
|
|
* @return array |
|
124
|
|
|
*/ |
|
125
|
|
|
public function getMessageTokens() |
|
126
|
|
|
{ |
|
127
|
|
|
return $this->messageTokens; |
|
128
|
|
|
} |
|
129
|
|
|
|
|
130
|
|
|
/** |
|
131
|
|
|
* @codeCoverageIgnore |
|
132
|
|
|
* |
|
133
|
|
|
* @return string |
|
134
|
|
|
*/ |
|
135
|
|
|
public function getExceptionMessage() |
|
136
|
|
|
{ |
|
137
|
|
|
return $this->exceptionMessage; |
|
138
|
|
|
} |
|
139
|
|
|
|
|
140
|
|
|
/** |
|
141
|
|
|
* @codeCoverageIgnore |
|
142
|
|
|
* |
|
143
|
|
|
* @param string $exceptionMessage |
|
144
|
|
|
*/ |
|
145
|
|
|
public function setExceptionMessage($exceptionMessage) |
|
146
|
|
|
{ |
|
147
|
|
|
$this->exceptionMessage = $exceptionMessage; |
|
148
|
|
|
} |
|
149
|
|
|
} |
dunkelfrosch /
phpcoverfish
