Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
bc77d7c0 | 4 | | Copyright CiviCRM LLC. All rights reserved. | |
6a488035 | 5 | | | |
bc77d7c0 TO |
6 | | This work is published under the GNU AGPLv3 license with some | |
7 | | permitted exceptions and without any warranty. For full license | | |
8 | | and copyright information, see https://civicrm.org/licensing | | |
6a488035 | 9 | +--------------------------------------------------------------------+ |
d25dd0ee | 10 | */ |
6a488035 TO |
11 | |
12 | /** | |
13 | * | |
14 | * @package CRM | |
ca5cec67 | 15 | * @copyright CiviCRM LLC https://civicrm.org/licensing |
6a488035 TO |
16 | */ |
17 | ||
18 | /** | |
19 | * BAO object for civicrm_setting table. This table is used to store civicrm settings that are not used | |
20 | * very frequently (i.e. not on every page load) | |
21 | * | |
22 | * The group column is used for grouping together all settings that logically belong to the same set. | |
23 | * Thus all settings in the same group are retrieved with one DB call and then cached for future needs. | |
6a488035 TO |
24 | */ |
25 | class CRM_Core_BAO_Setting extends CRM_Core_DAO_Setting { | |
26 | ||
27 | /** | |
fe482240 | 28 | * Various predefined settings that have been migrated to the setting table. |
6a488035 | 29 | */ |
7da04cde | 30 | const |
6a488035 TO |
31 | ADDRESS_STANDARDIZATION_PREFERENCES_NAME = 'Address Standardization Preferences', |
32 | CAMPAIGN_PREFERENCES_NAME = 'Campaign Preferences', | |
5d0140d9 | 33 | DEVELOPER_PREFERENCES_NAME = 'Developer Preferences', |
6a488035 TO |
34 | DIRECTORY_PREFERENCES_NAME = 'Directory Preferences', |
35 | EVENT_PREFERENCES_NAME = 'Event Preferences', | |
36 | MAILING_PREFERENCES_NAME = 'Mailing Preferences', | |
1ec598f3 | 37 | MAP_PREFERENCES_NAME = 'Map Preferences', |
6a488035 TO |
38 | CONTRIBUTE_PREFERENCES_NAME = 'Contribute Preferences', |
39 | MEMBER_PREFERENCES_NAME = 'Member Preferences', | |
40 | MULTISITE_PREFERENCES_NAME = 'Multi Site Preferences', | |
41 | PERSONAL_PREFERENCES_NAME = 'Personal Preferences', | |
42 | SYSTEM_PREFERENCES_NAME = 'CiviCRM Preferences', | |
43 | URL_PREFERENCES_NAME = 'URL Preferences', | |
44 | LOCALIZATION_PREFERENCES_NAME = 'Localization Preferences', | |
45 | SEARCH_PREFERENCES_NAME = 'Search Preferences'; | |
6a488035 | 46 | |
6a488035 | 47 | /** |
fe482240 | 48 | * Retrieve the value of a setting from the DB table. |
6a488035 | 49 | * |
6a0b768e | 50 | * @param string $group |
73152f09 | 51 | * The group name of the item (deprecated). |
6a0b768e TO |
52 | * @param string $name |
53 | * (required) The name under which this item is stored. | |
54 | * @param int $componentID | |
55 | * The optional component ID (so componenets can share the same name space). | |
56 | * @param string $defaultValue | |
57 | * The default value to return for this setting if not present in DB. | |
58 | * @param int $contactID | |
59 | * If set, this is a contactID specific setting, else its a global setting. | |
da6b46f4 | 60 | * |
100fef9d | 61 | * @param int $domainID |
6a488035 | 62 | * |
72b3a70c CW |
63 | * @return mixed |
64 | * The data if present in the setting table, else null | |
6a488035 | 65 | */ |
2da40d21 | 66 | public static function getItem( |
56cb3188 | 67 | $group, |
242bd179 TO |
68 | $name = NULL, |
69 | $componentID = NULL, | |
6a488035 | 70 | $defaultValue = NULL, |
242bd179 TO |
71 | $contactID = NULL, |
72 | $domainID = NULL | |
6a488035 | 73 | ) { |
3a84c0ab TO |
74 | /** @var \Civi\Core\SettingsManager $manager */ |
75 | $manager = \Civi::service('settings_manager'); | |
76 | $settings = ($contactID === NULL) ? $manager->getBagByDomain($domainID) : $manager->getBagByContact($domainID, $contactID); | |
73152f09 JK |
77 | if ($name === NULL) { |
78 | CRM_Core_Error::debug_log_message("Deprecated: Group='$group'. Name should be provided.\n"); | |
79 | } | |
80 | if ($componentID !== NULL) { | |
81 | CRM_Core_Error::debug_log_message("Deprecated: Group='$group'. Name='$name'. Component should be omitted\n"); | |
82 | } | |
83 | if ($defaultValue !== NULL) { | |
84 | CRM_Core_Error::debug_log_message("Deprecated: Group='$group'. Name='$name'. Defaults should come from metadata\n"); | |
6a488035 | 85 | } |
3a84c0ab | 86 | return $name ? $settings->get($name) : $settings->all(); |
6a488035 TO |
87 | } |
88 | ||
89 | /** | |
299cd62a | 90 | * Get multiple items from the setting table. |
6a488035 | 91 | * |
6a0b768e TO |
92 | * @param array $params |
93 | * (required) An api formatted array of keys and values. | |
35823763 | 94 | * @param array $domains Array of domains to get settings for. Default is the current domain |
dd244018 EM |
95 | * @param $settingsToReturn |
96 | * | |
35823763 | 97 | * @return array |
6a488035 | 98 | */ |
00be9182 | 99 | public static function getItems(&$params, $domains = NULL, $settingsToReturn) { |
0e04f44e | 100 | $originalDomain = CRM_Core_Config::domainID(); |
6a488035 | 101 | if (empty($domains)) { |
0e04f44e | 102 | $domains[] = $originalDomain; |
6a488035 TO |
103 | } |
104 | if (!empty($settingsToReturn) && !is_array($settingsToReturn)) { | |
be2fb01f | 105 | $settingsToReturn = [$settingsToReturn]; |
6a488035 | 106 | } |
0e04f44e | 107 | |
be2fb01f | 108 | $fields = $result = []; |
6a488035 | 109 | $fieldsToGet = self::validateSettingsInput(array_flip($settingsToReturn), $fields, FALSE); |
7583c3f3 | 110 | foreach ($domains as $domainID) { |
be2fb01f | 111 | $result[$domainID] = []; |
6a488035 | 112 | foreach ($fieldsToGet as $name => $value) { |
76bd16ab TO |
113 | $contactID = CRM_Utils_Array::value('contact_id', $params); |
114 | $setting = CRM_Core_BAO_Setting::getItem(NULL, $name, NULL, NULL, $contactID, $domainID); | |
6a488035 TO |
115 | if (!is_null($setting)) { |
116 | // we won't return if not set - helps in return all scenario - otherwise we can't indentify the missing ones | |
117 | // e.g for revert of fill actions | |
7583c3f3 | 118 | $result[$domainID][$name] = $setting; |
6a488035 TO |
119 | } |
120 | } | |
121 | } | |
122 | return $result; | |
123 | } | |
124 | ||
125 | /** | |
fe482240 | 126 | * Store an item in the setting table. |
6a488035 | 127 | * |
a57707d3 TO |
128 | * _setItem() is the common logic shared by setItem() and setItems(). |
129 | * | |
6a0b768e TO |
130 | * @param object $value |
131 | * (required) The value that will be serialized and stored. | |
132 | * @param string $group | |
73152f09 | 133 | * The group name of the item (deprecated). |
6a0b768e TO |
134 | * @param string $name |
135 | * (required) The name of the setting. | |
136 | * @param int $componentID | |
137 | * The optional component ID (so componenets can share the same name space). | |
100fef9d | 138 | * @param int $contactID |
6a0b768e TO |
139 | * @param int $createdID |
140 | * An optional ID to assign the creator to. If not set, retrieved from session. | |
fd31fa4c | 141 | * |
100fef9d | 142 | * @param int $domainID |
6a488035 | 143 | */ |
2da40d21 | 144 | public static function setItem( |
6a488035 TO |
145 | $value, |
146 | $group, | |
147 | $name, | |
148 | $componentID = NULL, | |
242bd179 TO |
149 | $contactID = NULL, |
150 | $createdID = NULL, | |
151 | $domainID = NULL | |
a57707d3 | 152 | ) { |
3a84c0ab TO |
153 | /** @var \Civi\Core\SettingsManager $manager */ |
154 | $manager = \Civi::service('settings_manager'); | |
155 | $settings = ($contactID === NULL) ? $manager->getBagByDomain($domainID) : $manager->getBagByContact($domainID, $contactID); | |
156 | $settings->set($name, $value); | |
a57707d3 TO |
157 | } |
158 | ||
6a488035 TO |
159 | /** |
160 | * Store multiple items in the setting table. Note that this will also store config keys | |
161 | * the storage is determined by the metdata and is affected by | |
162 | * 'name' setting's name | |
6a488035 TO |
163 | * 'config_key' = the config key is different to the settings key - e.g. debug where there was a conflict |
164 | * 'legacy_key' = rename from config or setting with this name | |
165 | * | |
a57707d3 TO |
166 | * _setItem() is the common logic shared by setItem() and setItems(). |
167 | * | |
6a0b768e TO |
168 | * @param array $params |
169 | * (required) An api formatted array of keys and values. | |
2a6da8d7 EM |
170 | * @param null $domains |
171 | * | |
172 | * @throws api_Exception | |
6a488035 | 173 | * @domains array an array of domains to get settings for. Default is the current domain |
3d0d359e | 174 | * @return array |
6a488035 | 175 | */ |
00be9182 | 176 | public static function setItems(&$params, $domains = NULL) { |
be2fb01f | 177 | $domains = empty($domains) ? [CRM_Core_Config::domainID()] : $domains; |
3a84c0ab TO |
178 | |
179 | // FIXME: redundant validation | |
180 | // FIXME: this whole thing should just be a loop to call $settings->add() on each domain. | |
181 | ||
be2fb01f | 182 | $fields = []; |
6a488035 TO |
183 | $fieldsToSet = self::validateSettingsInput($params, $fields); |
184 | ||
185 | foreach ($fieldsToSet as $settingField => &$settingValue) { | |
4cf5500c | 186 | if (empty($fields['values'][$settingField])) { |
be2fb01f CW |
187 | Civi::log()->warning('Deprecated Path: There is a setting (' . $settingField . ') not correctly defined. You may see unpredictability due to this. CRM_Core_Setting::setItems', ['civi.tag' => 'deprecated']); |
188 | $fields['values'][$settingField] = []; | |
4cf5500c | 189 | } |
6a488035 TO |
190 | self::validateSetting($settingValue, $fields['values'][$settingField]); |
191 | } | |
192 | ||
7583c3f3 | 193 | foreach ($domains as $domainID) { |
23bb9c85 TO |
194 | Civi::settings($domainID)->add($fieldsToSet); |
195 | $result[$domainID] = $fieldsToSet; | |
6a488035 TO |
196 | } |
197 | ||
198 | return $result; | |
199 | } | |
200 | ||
201 | /** | |
100fef9d | 202 | * Gets metadata about the settings fields (from getfields) based on the fields being passed in |
6a488035 TO |
203 | * |
204 | * This function filters on the fields like 'version' & 'debug' that are not settings | |
77b97be7 | 205 | * |
6a0b768e TO |
206 | * @param array $params |
207 | * Parameters as passed into API. | |
208 | * @param array $fields | |
209 | * Empty array to be populated with fields metadata. | |
6a488035 TO |
210 | * @param bool $createMode |
211 | * | |
77b97be7 | 212 | * @throws api_Exception |
a6c01b45 CW |
213 | * @return array |
214 | * name => value array of the fields to be set (with extraneous removed) | |
6a488035 | 215 | */ |
00be9182 | 216 | public static function validateSettingsInput($params, &$fields, $createMode = TRUE) { |
be2fb01f | 217 | $ignoredParams = [ |
6a488035 TO |
218 | 'version', |
219 | 'id', | |
220 | 'domain_id', | |
221 | 'debug', | |
222 | 'created_id', | |
223 | 'component_id', | |
224 | 'contact_id', | |
225 | 'filters', | |
226 | 'entity_id', | |
227 | 'entity_table', | |
228 | 'sequential', | |
229 | 'api.has_parent', | |
f704dce7 | 230 | 'IDS_request_uri', |
231 | 'IDS_user_agent', | |
232 | 'check_permissions', | |
80fbde47 | 233 | 'options', |
e56fd67f | 234 | 'prettyprint', |
2ed80443 FG |
235 | // CRM-18347: ignore params unintentionally passed by API explorer on WP |
236 | 'page', | |
237 | 'noheader', | |
238 | // CRM-18347: ignore params unintentionally passed by wp CLI tool | |
239 | '', | |
a3396545 FG |
240 | // CRM-19877: ignore params extraneously passed by Joomla |
241 | 'option', | |
242 | 'task', | |
be2fb01f | 243 | ]; |
6a488035 | 244 | $settingParams = array_diff_key($params, array_fill_keys($ignoredParams, TRUE)); |
be2fb01f | 245 | $getFieldsParams = ['version' => 3]; |
d3e86119 | 246 | if (count($settingParams) == 1) { |
6a488035 TO |
247 | // ie we are only setting one field - we'll pass it into getfields for efficiency |
248 | list($name) = array_keys($settingParams); | |
249 | $getFieldsParams['name'] = $name; | |
250 | } | |
353ffa53 | 251 | $fields = civicrm_api3('setting', 'getfields', $getFieldsParams); |
6a488035 TO |
252 | $invalidParams = (array_diff_key($settingParams, $fields['values'])); |
253 | if (!empty($invalidParams)) { | |
e56fd67f | 254 | throw new api_Exception(implode(',', array_keys($invalidParams)) . " not valid settings"); |
6a488035 TO |
255 | } |
256 | if (!empty($settingParams)) { | |
257 | $filteredFields = array_intersect_key($settingParams, $fields['values']); | |
258 | } | |
259 | else { | |
260 | // no filters so we are interested in all for get mode. In create mode this means nothing to set | |
be2fb01f | 261 | $filteredFields = $createMode ? [] : $fields['values']; |
6a488035 TO |
262 | } |
263 | return $filteredFields; | |
264 | } | |
265 | ||
266 | /** | |
3bdf1f3a | 267 | * Validate & convert settings input. |
6a488035 | 268 | * |
3bdf1f3a | 269 | * @param mixed $value |
270 | * value of the setting to be set | |
271 | * @param array $fieldSpec | |
272 | * Metadata for given field (drawn from the xml) | |
273 | * | |
274 | * @return bool | |
275 | * @throws \api_Exception | |
6a488035 | 276 | */ |
e566ea47 | 277 | public static function validateSetting(&$value, array $fieldSpec) { |
9b873358 | 278 | if ($fieldSpec['type'] == 'String' && is_array($value)) { |
353ffa53 | 279 | $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $value) . CRM_Core_DAO::VALUE_SEPARATOR; |
6a488035 TO |
280 | } |
281 | if (empty($fieldSpec['validate_callback'])) { | |
607cb45e | 282 | return TRUE; |
6a488035 TO |
283 | } |
284 | else { | |
c8074a93 TO |
285 | $cb = Civi\Core\Resolver::singleton()->get($fieldSpec['validate_callback']); |
286 | if (!call_user_func_array($cb, array(&$value, $fieldSpec))) { | |
ee7b49c4 | 287 | throw new api_Exception("validation failed for {$fieldSpec['name']} = $value based on callback {$fieldSpec['validate_callback']}"); |
6a488035 TO |
288 | } |
289 | } | |
290 | } | |
291 | ||
292 | /** | |
ea3ddccf | 293 | * Validate & convert settings input - translate True False to 0 or 1. |
6a488035 | 294 | * |
ea3ddccf | 295 | * @param mixed $value value of the setting to be set |
296 | * @param array $fieldSpec Metadata for given field (drawn from the xml) | |
297 | * | |
298 | * @return bool | |
299 | * @throws \api_Exception | |
6a488035 | 300 | */ |
00be9182 | 301 | public static function validateBoolSetting(&$value, $fieldSpec) { |
6a488035 | 302 | if (!CRM_Utils_Rule::boolean($value)) { |
ee7b49c4 | 303 | throw new api_Exception("Boolean value required for {$fieldSpec['name']}"); |
6a488035 TO |
304 | } |
305 | if (!$value) { | |
306 | $value = 0; | |
307 | } | |
308 | else { | |
309 | $value = 1; | |
310 | } | |
311 | return TRUE; | |
312 | } | |
313 | ||
6a488035 TO |
314 | /** |
315 | * This provides information about the setting - similar to the fields concept for DAO information. | |
316 | * As the setting is serialized code creating validation setting input needs to know the data type | |
317 | * This also helps move information out of the form layer into the data layer where people can interact with | |
318 | * it via the API or other mechanisms. In order to keep this consistent it is important the form layer | |
319 | * also leverages it. | |
320 | * | |
321 | * Note that this function should never be called when using the runtime getvalue function. Caching works | |
322 | * around the expectation it will be called during setting administration | |
323 | * | |
324 | * Function is intended for configuration rather than runtime access to settings | |
325 | * | |
326 | * The following params will filter the result. If none are passed all settings will be returns | |
327 | * | |
6a0b768e TO |
328 | * @param int $componentID |
329 | * Id of relevant component. | |
2a6da8d7 | 330 | * @param array $filters |
c490a46a | 331 | * @param int $domainID |
2a6da8d7 EM |
332 | * @param null $profile |
333 | * | |
a6c01b45 CW |
334 | * @return array |
335 | * the following information as appropriate for each setting | |
5c766a0b TO |
336 | * - name |
337 | * - type | |
338 | * - default | |
339 | * - add (CiviCRM version added) | |
340 | * - is_domain | |
341 | * - is_contact | |
342 | * - description | |
343 | * - help_text | |
6a488035 | 344 | */ |
2da40d21 | 345 | public static function getSettingSpecification( |
607cb45e | 346 | $componentID = NULL, |
be2fb01f | 347 | $filters = [], |
607cb45e TO |
348 | $domainID = NULL, |
349 | $profile = NULL | |
b597d0b1 | 350 | ) { |
e1d39824 | 351 | return \Civi\Core\SettingsMetadata::getMetadata($filters, $domainID); |
6a488035 TO |
352 | } |
353 | ||
b5c2afd0 EM |
354 | /** |
355 | * @param $group | |
100fef9d | 356 | * @param string $name |
b5c2afd0 | 357 | * @param bool $system |
100fef9d | 358 | * @param int $userID |
b5c2afd0 EM |
359 | * @param bool $localize |
360 | * @param string $returnField | |
361 | * @param bool $returnNameANDLabels | |
362 | * @param null $condition | |
363 | * | |
364 | * @return array | |
365 | */ | |
2da40d21 | 366 | public static function valueOptions( |
f9f40af3 | 367 | $group, |
6a488035 | 368 | $name, |
242bd179 TO |
369 | $system = TRUE, |
370 | $userID = NULL, | |
371 | $localize = FALSE, | |
372 | $returnField = 'name', | |
6a488035 | 373 | $returnNameANDLabels = FALSE, |
242bd179 | 374 | $condition = NULL |
6a488035 TO |
375 | ) { |
376 | $optionValue = self::getItem($group, $name); | |
377 | ||
378 | $groupValues = CRM_Core_OptionGroup::values($name, FALSE, FALSE, $localize, $condition, $returnField); | |
379 | ||
380 | //enabled name => label require for new contact edit form, CRM-4605 | |
381 | if ($returnNameANDLabels) { | |
be2fb01f | 382 | $names = $labels = $nameAndLabels = []; |
6a488035 TO |
383 | if ($returnField == 'name') { |
384 | $names = $groupValues; | |
385 | $labels = CRM_Core_OptionGroup::values($name, FALSE, FALSE, $localize, $condition, 'label'); | |
386 | } | |
387 | else { | |
388 | $labels = $groupValues; | |
389 | $names = CRM_Core_OptionGroup::values($name, FALSE, FALSE, $localize, $condition, 'name'); | |
390 | } | |
391 | } | |
392 | ||
be2fb01f | 393 | $returnValues = []; |
6a488035 TO |
394 | foreach ($groupValues as $gn => $gv) { |
395 | $returnValues[$gv] = 0; | |
396 | } | |
397 | ||
398 | if ($optionValue && !empty($groupValues)) { | |
399 | $dbValues = explode(CRM_Core_DAO::VALUE_SEPARATOR, | |
400 | substr($optionValue, 1, -1) | |
401 | ); | |
402 | ||
403 | if (!empty($dbValues)) { | |
404 | foreach ($groupValues as $key => $val) { | |
405 | if (in_array($key, $dbValues)) { | |
406 | $returnValues[$val] = 1; | |
407 | if ($returnNameANDLabels) { | |
408 | $nameAndLabels[$names[$key]] = $labels[$key]; | |
409 | } | |
410 | } | |
411 | } | |
412 | } | |
413 | } | |
414 | return ($returnNameANDLabels) ? $nameAndLabels : $returnValues; | |
415 | } | |
416 | ||
b5c2afd0 | 417 | /** |
73152f09 | 418 | * @param $group (deprecated) |
100fef9d | 419 | * @param string $name |
b5c2afd0 EM |
420 | * @param $value |
421 | * @param bool $system | |
100fef9d | 422 | * @param int $userID |
b5c2afd0 EM |
423 | * @param string $keyField |
424 | */ | |
2da40d21 | 425 | public static function setValueOption( |
f9f40af3 | 426 | $group, |
6a488035 TO |
427 | $name, |
428 | $value, | |
242bd179 TO |
429 | $system = TRUE, |
430 | $userID = NULL, | |
6a488035 TO |
431 | $keyField = 'name' |
432 | ) { | |
433 | if (empty($value)) { | |
434 | $optionValue = NULL; | |
435 | } | |
436 | elseif (is_array($value)) { | |
437 | $groupValues = CRM_Core_OptionGroup::values($name, FALSE, FALSE, FALSE, NULL, $keyField); | |
438 | ||
be2fb01f | 439 | $cbValues = []; |
6a488035 | 440 | foreach ($groupValues as $key => $val) { |
a7488080 | 441 | if (!empty($value[$val])) { |
6a488035 TO |
442 | $cbValues[$key] = 1; |
443 | } | |
444 | } | |
445 | ||
446 | if (!empty($cbValues)) { | |
447 | $optionValue = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, | |
353ffa53 TO |
448 | array_keys($cbValues) |
449 | ) . CRM_Core_DAO::VALUE_SEPARATOR; | |
6a488035 TO |
450 | } |
451 | else { | |
452 | $optionValue = NULL; | |
453 | } | |
454 | } | |
455 | else { | |
456 | $optionValue = $value; | |
457 | } | |
458 | ||
459 | self::setItem($optionValue, $group, $name); | |
460 | } | |
461 | ||
f008885c E |
462 | /** |
463 | * Check if environment is explicitly set. | |
464 | * | |
465 | * @return bool | |
466 | */ | |
467 | public static function isEnvironmentSet($setting, $value = NULL) { | |
468 | $environment = CRM_Core_Config::environment(); | |
469 | if ($setting == 'environment' && $environment) { | |
470 | return TRUE; | |
471 | } | |
472 | return FALSE; | |
473 | } | |
474 | ||
475 | /** | |
476 | * Check if job is able to be executed by API. | |
477 | * | |
478 | * @throws API_Exception | |
479 | */ | |
480 | public static function isAPIJobAllowedToRun($params) { | |
03c5ceba | 481 | $environment = CRM_Core_Config::environment(NULL, TRUE); |
482 | if ($environment != 'Production') { | |
de6c59ca | 483 | if (!empty($params['runInNonProductionEnvironment'])) { |
03c5ceba | 484 | $mailing = Civi::settings()->get('mailing_backend_store'); |
485 | if ($mailing) { | |
486 | Civi::settings()->set('mailing_backend', $mailing); | |
487 | } | |
488 | } | |
489 | else { | |
be2fb01f | 490 | throw new Exception(ts("Job has not been executed as it is a %1 (non-production) environment.", [1 => $environment])); |
03c5ceba | 491 | } |
492 | } | |
493 | } | |
494 | ||
495 | /** | |
496 | * Setting Callback - On Change. | |
497 | * | |
498 | * Respond to changes in the "environment" setting. | |
499 | * | |
500 | * @param array $oldValue | |
501 | * Value of old environment mode. | |
502 | * @param array $newValue | |
503 | * Value of new environment mode. | |
504 | * @param array $metadata | |
505 | * Specification of the setting (per *.settings.php). | |
506 | */ | |
507 | public static function onChangeEnvironmentSetting($oldValue, $newValue, $metadata) { | |
508 | if ($newValue != 'Production') { | |
509 | $mailing = Civi::settings()->get('mailing_backend'); | |
510 | if ($mailing['outBound_option'] != 2) { | |
511 | Civi::settings()->set('mailing_backend_store', $mailing); | |
512 | } | |
be2fb01f | 513 | Civi::settings()->set('mailing_backend', ['outBound_option' => CRM_Mailing_Config::OUTBOUND_OPTION_DISABLED]); |
03c5ceba | 514 | CRM_Core_Session::setStatus(ts('Outbound emails have been disabled. Scheduled jobs will not run unless runInNonProductionEnvironment=TRUE is added as a parameter for a specific job'), ts("Non-production environment set"), "success"); |
515 | } | |
516 | else { | |
517 | $mailing = Civi::settings()->get('mailing_backend_store'); | |
518 | if ($mailing) { | |
519 | Civi::settings()->set('mailing_backend', $mailing); | |
520 | } | |
f008885c E |
521 | } |
522 | } | |
523 | ||
2c7039ef | 524 | } |