Commit | Line | Data |
---|---|---|
e501603b | 1 | <?php |
c3fc2621 | 2 | |
e501603b TO |
3 | /** |
4 | * @package CRM | |
8c9251b3 | 5 | * @copyright CiviCRM LLC (c) 2004-2018 |
e501603b TO |
6 | * |
7 | * Generated from xml/schema/CRM/Core/StatusPreference.xml | |
8 | * DO NOT EDIT. Generated by CRM_Core_CodeGen | |
e7a6b91a | 9 | * (GenCodeChecksum:6a9e433b487d14f9b8e036f8491e6a9c) |
e501603b | 10 | */ |
c3fc2621 | 11 | |
f41f0342 | 12 | /** |
c3fc2621 | 13 | * Database access object for the StatusPreference entity. |
f41f0342 | 14 | */ |
e501603b | 15 | class CRM_Core_DAO_StatusPreference extends CRM_Core_DAO { |
c3fc2621 | 16 | |
e501603b | 17 | /** |
f41f0342 | 18 | * Static instance to hold the table name. |
e501603b TO |
19 | * |
20 | * @var string | |
21 | */ | |
22 | static $_tableName = 'civicrm_status_pref'; | |
c3fc2621 | 23 | |
e501603b | 24 | /** |
f41f0342 | 25 | * Should CiviCRM log any modifications to this table in the civicrm_log table. |
e501603b | 26 | * |
c3fc2621 | 27 | * @var bool |
e501603b | 28 | */ |
c3fc2621 CW |
29 | static $_log = FALSE; |
30 | ||
e501603b TO |
31 | /** |
32 | * Unique Status Preference ID | |
33 | * | |
34 | * @var int unsigned | |
35 | */ | |
36 | public $id; | |
c3fc2621 | 37 | |
e501603b TO |
38 | /** |
39 | * Which Domain is this Status Preference for | |
40 | * | |
41 | * @var int unsigned | |
42 | */ | |
43 | public $domain_id; | |
c3fc2621 | 44 | |
e501603b TO |
45 | /** |
46 | * Name of the status check this preference references. | |
47 | * | |
48 | * @var string | |
49 | */ | |
50 | public $name; | |
c3fc2621 | 51 | |
e501603b TO |
52 | /** |
53 | * expires ignore_severity. NULL never hushes. | |
54 | * | |
55 | * @var date | |
56 | */ | |
57 | public $hush_until; | |
c3fc2621 | 58 | |
e501603b TO |
59 | /** |
60 | * Hush messages up to and including this severity. | |
61 | * | |
62 | * @var int unsigned | |
63 | */ | |
64 | public $ignore_severity; | |
c3fc2621 | 65 | |
e501603b TO |
66 | /** |
67 | * These settings are per-check, and can't be compared across checks. | |
68 | * | |
69 | * @var string | |
70 | */ | |
71 | public $prefs; | |
c3fc2621 | 72 | |
e501603b TO |
73 | /** |
74 | * These values are per-check, and can't be compared across checks. | |
75 | * | |
76 | * @var string | |
77 | */ | |
78 | public $check_info; | |
c3fc2621 | 79 | |
e501603b | 80 | /** |
f41f0342 | 81 | * Class constructor. |
e501603b | 82 | */ |
c3fc2621 | 83 | public function __construct() { |
e501603b TO |
84 | $this->__table = 'civicrm_status_pref'; |
85 | parent::__construct(); | |
86 | } | |
c3fc2621 | 87 | |
e501603b | 88 | /** |
f41f0342 | 89 | * Returns foreign keys and entity references. |
e501603b TO |
90 | * |
91 | * @return array | |
92 | * [CRM_Core_Reference_Interface] | |
93 | */ | |
c3fc2621 | 94 | public static function getReferenceColumns() { |
346aaaba TO |
95 | if (!isset(Civi::$statics[__CLASS__]['links'])) { |
96 | Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__); | |
c3fc2621 | 97 | Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'domain_id', 'civicrm_domain', 'id'); |
346aaaba | 98 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']); |
e501603b | 99 | } |
346aaaba | 100 | return Civi::$statics[__CLASS__]['links']; |
e501603b | 101 | } |
c3fc2621 | 102 | |
e501603b TO |
103 | /** |
104 | * Returns all the column names of this table | |
105 | * | |
106 | * @return array | |
107 | */ | |
c3fc2621 | 108 | public static function &fields() { |
346aaaba | 109 | if (!isset(Civi::$statics[__CLASS__]['fields'])) { |
c3fc2621 CW |
110 | Civi::$statics[__CLASS__]['fields'] = [ |
111 | 'id' => [ | |
e501603b TO |
112 | 'name' => 'id', |
113 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 114 | 'title' => ts('Status Preference ID'), |
e501603b | 115 | 'description' => 'Unique Status Preference ID', |
c3fc2621 | 116 | 'required' => TRUE, |
522a26c9 | 117 | 'table_name' => 'civicrm_status_pref', |
118 | 'entity' => 'StatusPreference', | |
119 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 120 | 'localizable' => 0, |
c3fc2621 CW |
121 | ], |
122 | 'domain_id' => [ | |
e501603b TO |
123 | 'name' => 'domain_id', |
124 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 125 | 'title' => ts('Setting Domain'), |
e501603b | 126 | 'description' => 'Which Domain is this Status Preference for', |
c3fc2621 | 127 | 'required' => TRUE, |
522a26c9 | 128 | 'table_name' => 'civicrm_status_pref', |
129 | 'entity' => 'StatusPreference', | |
130 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 131 | 'localizable' => 0, |
e501603b | 132 | 'FKClassName' => 'CRM_Core_DAO_Domain', |
c3fc2621 | 133 | 'pseudoconstant' => [ |
e501603b TO |
134 | 'table' => 'civicrm_domain', |
135 | 'keyColumn' => 'id', | |
136 | 'labelColumn' => 'name', | |
c3fc2621 CW |
137 | ] |
138 | ], | |
139 | 'name' => [ | |
e501603b TO |
140 | 'name' => 'name', |
141 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 142 | 'title' => ts('Status Check Name'), |
e501603b | 143 | 'description' => 'Name of the status check this preference references.', |
c3fc2621 | 144 | 'required' => TRUE, |
e501603b TO |
145 | 'maxlength' => 255, |
146 | 'size' => CRM_Utils_Type::HUGE, | |
c3fc2621 | 147 | 'import' => TRUE, |
e501603b TO |
148 | 'where' => 'civicrm_status_pref.name', |
149 | 'headerPattern' => '', | |
150 | 'dataPattern' => '', | |
c3fc2621 | 151 | 'export' => TRUE, |
522a26c9 | 152 | 'table_name' => 'civicrm_status_pref', |
153 | 'entity' => 'StatusPreference', | |
154 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 155 | 'localizable' => 0, |
c3fc2621 CW |
156 | ], |
157 | 'hush_until' => [ | |
e501603b TO |
158 | 'name' => 'hush_until', |
159 | 'type' => CRM_Utils_Type::T_DATE, | |
c3fc2621 | 160 | 'title' => ts('Snooze Status Notifications Until'), |
e501603b | 161 | 'description' => 'expires ignore_severity. NULL never hushes.', |
c3fc2621 | 162 | 'import' => TRUE, |
e501603b TO |
163 | 'where' => 'civicrm_status_pref.hush_until', |
164 | 'headerPattern' => '', | |
165 | 'dataPattern' => '', | |
c3fc2621 | 166 | 'export' => TRUE, |
e501603b | 167 | 'default' => 'NULL', |
522a26c9 | 168 | 'table_name' => 'civicrm_status_pref', |
169 | 'entity' => 'StatusPreference', | |
170 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 171 | 'localizable' => 0, |
c3fc2621 CW |
172 | ], |
173 | 'ignore_severity' => [ | |
e501603b TO |
174 | 'name' => 'ignore_severity', |
175 | 'type' => CRM_Utils_Type::T_INT, | |
c3fc2621 | 176 | 'title' => ts('Ignore Severity'), |
e501603b | 177 | 'description' => 'Hush messages up to and including this severity.', |
c3fc2621 | 178 | 'import' => TRUE, |
e501603b TO |
179 | 'where' => 'civicrm_status_pref.ignore_severity', |
180 | 'headerPattern' => '', | |
181 | 'dataPattern' => '', | |
c3fc2621 | 182 | 'export' => TRUE, |
e501603b | 183 | 'default' => '1', |
522a26c9 | 184 | 'table_name' => 'civicrm_status_pref', |
185 | 'entity' => 'StatusPreference', | |
186 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 187 | 'localizable' => 0, |
c3fc2621 | 188 | 'pseudoconstant' => [ |
e501603b | 189 | 'callback' => 'CRM_Utils_Check::getSeverityList', |
c3fc2621 CW |
190 | ] |
191 | ], | |
192 | 'prefs' => [ | |
e501603b TO |
193 | 'name' => 'prefs', |
194 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 195 | 'title' => ts('Status Preferences'), |
e501603b TO |
196 | 'description' => 'These settings are per-check, and can\'t be compared across checks.', |
197 | 'maxlength' => 255, | |
198 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 199 | 'table_name' => 'civicrm_status_pref', |
200 | 'entity' => 'StatusPreference', | |
201 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 202 | 'localizable' => 0, |
c3fc2621 CW |
203 | ], |
204 | 'check_info' => [ | |
e501603b TO |
205 | 'name' => 'check_info', |
206 | 'type' => CRM_Utils_Type::T_STRING, | |
c3fc2621 | 207 | 'title' => ts('Check Info'), |
e501603b TO |
208 | 'description' => 'These values are per-check, and can\'t be compared across checks.', |
209 | 'maxlength' => 255, | |
210 | 'size' => CRM_Utils_Type::HUGE, | |
522a26c9 | 211 | 'table_name' => 'civicrm_status_pref', |
212 | 'entity' => 'StatusPreference', | |
213 | 'bao' => 'CRM_Core_BAO_StatusPreference', | |
6a7e5e5d | 214 | 'localizable' => 0, |
c3fc2621 CW |
215 | ], |
216 | ]; | |
346aaaba | 217 | CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']); |
e501603b | 218 | } |
346aaaba | 219 | return Civi::$statics[__CLASS__]['fields']; |
e501603b | 220 | } |
c3fc2621 | 221 | |
e501603b | 222 | /** |
bd8e0b14 | 223 | * Return a mapping from field-name to the corresponding key (as used in fields()). |
e501603b TO |
224 | * |
225 | * @return array | |
bd8e0b14 | 226 | * Array(string $name => string $uniqueName). |
e501603b | 227 | */ |
c3fc2621 | 228 | public static function &fieldKeys() { |
bd8e0b14 TO |
229 | if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) { |
230 | Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields())); | |
e501603b | 231 | } |
bd8e0b14 | 232 | return Civi::$statics[__CLASS__]['fieldKeys']; |
e501603b | 233 | } |
c3fc2621 | 234 | |
e501603b TO |
235 | /** |
236 | * Returns the names of this table | |
237 | * | |
238 | * @return string | |
239 | */ | |
c3fc2621 | 240 | public static function getTableName() { |
e501603b TO |
241 | return self::$_tableName; |
242 | } | |
c3fc2621 | 243 | |
e501603b TO |
244 | /** |
245 | * Returns if this table needs to be logged | |
246 | * | |
c3fc2621 | 247 | * @return bool |
e501603b | 248 | */ |
c3fc2621 | 249 | public function getLog() { |
e501603b TO |
250 | return self::$_log; |
251 | } | |
c3fc2621 | 252 | |
e501603b TO |
253 | /** |
254 | * Returns the list of fields that can be imported | |
255 | * | |
256 | * @param bool $prefix | |
257 | * | |
258 | * @return array | |
259 | */ | |
c3fc2621 CW |
260 | public static function &import($prefix = FALSE) { |
261 | $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'status_pref', $prefix, []); | |
60808919 | 262 | return $r; |
e501603b | 263 | } |
c3fc2621 | 264 | |
e501603b TO |
265 | /** |
266 | * Returns the list of fields that can be exported | |
267 | * | |
268 | * @param bool $prefix | |
269 | * | |
270 | * @return array | |
271 | */ | |
c3fc2621 CW |
272 | public static function &export($prefix = FALSE) { |
273 | $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'status_pref', $prefix, []); | |
60808919 | 274 | return $r; |
e501603b | 275 | } |
c3fc2621 | 276 | |
e7a6b91a AS |
277 | /** |
278 | * Returns the list of indices | |
c3fc2621 CW |
279 | * |
280 | * @param bool $localize | |
281 | * | |
282 | * @return array | |
e7a6b91a AS |
283 | */ |
284 | public static function indices($localize = TRUE) { | |
c3fc2621 CW |
285 | $indices = [ |
286 | 'UI_status_pref_name' => [ | |
e7a6b91a | 287 | 'name' => 'UI_status_pref_name', |
c3fc2621 | 288 | 'field' => [ |
e7a6b91a | 289 | 0 => 'name', |
c3fc2621 CW |
290 | ], |
291 | 'localizable' => FALSE, | |
e7a6b91a | 292 | 'sig' => 'civicrm_status_pref::0::name', |
c3fc2621 CW |
293 | ], |
294 | ]; | |
e7a6b91a AS |
295 | return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; |
296 | } | |
c3fc2621 | 297 | |
e501603b | 298 | } |