Commit | Line | Data |
---|---|---|
a2600a6d TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
a2600a6d | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
a2600a6d TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
10 | | CiviCRM is free software; you can copy, modify, and distribute it | | |
11 | | under the terms of the GNU Affero General Public License | | |
12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | |
13 | | | | |
14 | | CiviCRM is distributed in the hope that it will be useful, but | | |
15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | | |
16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | |
17 | | See the GNU Affero General Public License for more details. | | |
18 | | | | |
19 | | You should have received a copy of the GNU Affero General Public | | |
20 | | License and the CiviCRM Licensing Exception along | | |
21 | | with this program; if not, contact CiviCRM LLC | | |
22 | | at info[AT]civicrm[DOT]org. If you have questions about the | | |
23 | | GNU Affero General Public License or the licensing of CiviCRM, | | |
24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | | |
25 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
a2600a6d TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
a2600a6d TO |
32 | * $Id: $ |
33 | * | |
34 | */ | |
35 | class CRM_Utils_Check_Message { | |
36 | /** | |
37 | * @var string | |
38 | */ | |
39 | private $name; | |
40 | ||
41 | /** | |
42 | * @var string | |
43 | */ | |
44 | private $message; | |
45 | ||
1248c859 TO |
46 | /** |
47 | * @var string | |
48 | */ | |
49 | private $title; | |
50 | ||
f0f49b45 TO |
51 | /** |
52 | * @var string | |
53 | * @see Psr\Log\LogLevel | |
54 | */ | |
55 | private $level; | |
56 | ||
1b366958 AH |
57 | /** |
58 | * @var string | |
59 | * help text (to be presented separately from the message) | |
60 | */ | |
61 | private $help; | |
62 | ||
5bc392e6 | 63 | /** |
100fef9d | 64 | * @param string $name |
f0f49b45 TO |
65 | * Symbolic name for the check. |
66 | * @param string $message | |
67 | * Printable message (short or long). | |
68 | * @param string $title | |
69 | * Printable message (short). | |
70 | * @param string $level | |
71 | * The severity of the message. Use PSR-3 log levels. | |
72 | * | |
73 | * @see Psr\Log\LogLevel | |
5bc392e6 | 74 | */ |
f0f49b45 | 75 | public function __construct($name, $message, $title, $level = \Psr\Log\LogLevel::WARNING) { |
a2600a6d TO |
76 | $this->name = $name; |
77 | $this->message = $message; | |
1248c859 | 78 | $this->title = $title; |
70c711fe J |
79 | // Handle non-integer severity levels. |
80 | if (!CRM_Utils_Rule::integer($level)) { | |
81 | $level = CRM_Utils_Check::severityMap($level); | |
82 | } | |
f0f49b45 | 83 | $this->level = $level; |
a2600a6d TO |
84 | } |
85 | ||
86 | /** | |
87 | * @return string | |
88 | */ | |
00be9182 | 89 | public function getName() { |
a2600a6d TO |
90 | return $this->name; |
91 | } | |
92 | ||
93 | /** | |
94 | * @return string | |
95 | */ | |
00be9182 | 96 | public function getMessage() { |
a2600a6d TO |
97 | return $this->message; |
98 | } | |
99 | ||
1248c859 TO |
100 | /** |
101 | * @return string | |
102 | */ | |
103 | public function getTitle() { | |
104 | return $this->title; | |
105 | } | |
106 | ||
f0f49b45 TO |
107 | /** |
108 | * @return string | |
109 | * @see Psr\Log\LogLevel | |
110 | */ | |
111 | public function getLevel() { | |
112 | return $this->level; | |
113 | } | |
114 | ||
0ea9001d | 115 | /** |
116 | * Alias for Level | |
117 | * @return string | |
1b366958 | 118 | */ |
0ea9001d | 119 | public function getSeverity() { |
120 | return $this->getLevel(); | |
121 | } | |
122 | ||
1b366958 AH |
123 | /** |
124 | * Set optional additional help text | |
097c681e | 125 | * @param string $help |
1b366958 AH |
126 | */ |
127 | public function addHelp($help) { | |
128 | $this->help = $help; | |
129 | } | |
130 | ||
a2600a6d TO |
131 | /** |
132 | * @return array | |
133 | */ | |
00be9182 | 134 | public function toArray() { |
1b366958 | 135 | $array = array( |
a2600a6d TO |
136 | 'name' => $this->name, |
137 | 'message' => $this->message, | |
1248c859 | 138 | 'title' => $this->title, |
1b366958 | 139 | 'severity' => $this->level, |
a2600a6d | 140 | ); |
1b366958 AH |
141 | if (!empty($this->help)) { |
142 | $array['help'] = $this->help; | |
143 | } | |
144 | return $array; | |
a2600a6d | 145 | } |
96025800 | 146 | |
a2600a6d | 147 | } |