From 08ef4ddd8b2fe7aaa959c0b30bfef73e931c1d21 Mon Sep 17 00:00:00 2001 From: Coleman Watts Date: Sun, 6 Dec 2015 22:29:07 -0500 Subject: [PATCH] CRM-17507 - Cleanup settings setItem calls --- CRM/Admin/Form/Preferences.php | 5 +---- CRM/Admin/Form/Preferences/Contribute.php | 7 +++---- CRM/Admin/Form/Preferences/Mailing.php | 2 +- CRM/Admin/Form/Setting.php | 10 ++-------- CRM/Admin/Form/Setting/Smtp.php | 5 +---- CRM/Core/Resources.php | 2 +- CRM/Upgrade/Incremental/php/FourSeven.php | 2 +- tests/phpunit/CRM/Core/BAO/SettingTest.php | 14 +++----------- .../phpunit/CRM/Core/Payment/AuthorizeNetTest.php | 8 ++++---- tests/phpunit/CiviTest/CiviMailUtils.php | 10 ++-------- tests/phpunit/api/v3/TaxContributionPageTest.php | 2 +- 11 files changed, 20 insertions(+), 47 deletions(-) diff --git a/CRM/Admin/Form/Preferences.php b/CRM/Admin/Form/Preferences.php index d8e19ec4c8..6b35849c9f 100644 --- a/CRM/Admin/Form/Preferences.php +++ b/CRM/Admin/Form/Preferences.php @@ -288,10 +288,7 @@ class CRM_Admin_Form_Preferences extends CRM_Core_Form { foreach ($this->_varNames as $groupName => $groupValues) { foreach ($groupValues as $settingName => $fieldValue) { $settingValue = isset($this->_config->$settingName) ? $this->_config->$settingName : NULL; - CRM_Core_BAO_Setting::setItem($settingValue, - $groupName, - $settingName - ); + Civi::settings()->set($settingName, $settingValue); } } // Update any settings stored in dynamic js diff --git a/CRM/Admin/Form/Preferences/Contribute.php b/CRM/Admin/Form/Preferences/Contribute.php index 0a5513cbd2..d3b1fc8c79 100644 --- a/CRM/Admin/Form/Preferences/Contribute.php +++ b/CRM/Admin/Form/Preferences/Contribute.php @@ -173,7 +173,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { $params = $this->controller->exportValues($this->_name); unset($params['qfKey']); unset($params['entryURL']); - $setInvoiceSettings = CRM_Core_BAO_Setting::setItem($params, CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings'); + Civi::settings()->set('contribution_invoice_settings', $params); // to set default value for 'Invoices / Credit Notes' checkbox on display preferences $values = CRM_Core_BAO_Setting::getItem("CiviCRM Preferences"); @@ -185,8 +185,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { $setInvoice = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, array_keys($value)) . CRM_Core_DAO::VALUE_SEPARATOR; - CRM_Core_BAO_Setting::setItem($values['user_dashboard_options'] . - $setInvoice, 'CiviCRM Preferences', 'user_dashboard_options'); + Civi::settings()->set('user_dashboard_options', $values['user_dashboard_options'] . $setInvoice); } else { $setting = explode(CRM_Core_DAO::VALUE_SEPARATOR, substr($values['user_dashboard_options'], 1, -1)); @@ -195,7 +194,7 @@ class CRM_Admin_Form_Preferences_Contribute extends CRM_Admin_Form_Preferences { $settingName = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, array_values($setting)) . CRM_Core_DAO::VALUE_SEPARATOR; - CRM_Core_BAO_Setting::setItem($settingName, 'CiviCRM Preferences', 'user_dashboard_options'); + Civi::settings()->set('user_dashboard_options', $settingName); } //CRM-16691: Changes made related to settings of 'CVV'. $settings = array_intersect_key($params, $this->_settings); diff --git a/CRM/Admin/Form/Preferences/Mailing.php b/CRM/Admin/Form/Preferences/Mailing.php index 63bdb2072a..1c41c07922 100644 --- a/CRM/Admin/Form/Preferences/Mailing.php +++ b/CRM/Admin/Form/Preferences/Mailing.php @@ -127,7 +127,7 @@ class CRM_Admin_Form_Preferences_Mailing extends CRM_Admin_Form_Preferences { if (!in_array($displayValue, $viewOptions)) { $existingViewOptions .= $displayValue . CRM_Core_DAO::VALUE_SEPARATOR; - CRM_Core_BAO_Setting::setItem($existingViewOptions, CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'contact_view_options'); + Civi::settings()->set('contact_view_options', $existingViewOptions); CRM_Core_Session::setStatus(ts('We have automatically enabled the Mailings tab for the Contact Summary screens so that you can view mailings sent to each contact.'), ts('Saved'), 'success'); } diff --git a/CRM/Admin/Form/Setting.php b/CRM/Admin/Form/Setting.php index 90b494806d..e1b743caad 100644 --- a/CRM/Admin/Form/Setting.php +++ b/CRM/Admin/Form/Setting.php @@ -200,19 +200,13 @@ class CRM_Admin_Form_Setting extends CRM_Core_Form { // verify ssl peer option if (isset($params['verifySSL'])) { - CRM_Core_BAO_Setting::setItem($params['verifySSL'], - CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, - 'verifySSL' - ); + Civi::settings()->set('verifySSL', $params['verifySSL']); unset($params['verifySSL']); } // force secure URLs if (isset($params['enableSSL'])) { - CRM_Core_BAO_Setting::setItem($params['enableSSL'], - CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, - 'enableSSL' - ); + Civi::settings()->set('enableSSL', $params['enableSSL']); unset($params['enableSSL']); } $settings = array_intersect_key($params, $this->_settings); diff --git a/CRM/Admin/Form/Setting/Smtp.php b/CRM/Admin/Form/Setting/Smtp.php index 1eb9661009..84272a9583 100644 --- a/CRM/Admin/Form/Setting/Smtp.php +++ b/CRM/Admin/Form/Setting/Smtp.php @@ -187,10 +187,7 @@ class CRM_Admin_Form_Setting_Smtp extends CRM_Admin_Form_Setting { $formValues['smtpPassword'] = CRM_Utils_Crypt::encrypt($formValues['smtpPassword']); } - CRM_Core_BAO_Setting::setItem($formValues, - CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, - 'mailing_backend' - ); + Civi::settings()->set('mailing_backend', $formValues); } /** diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php index 08d6f05a09..b9ff1e7f3c 100644 --- a/CRM/Core/Resources.php +++ b/CRM/Core/Resources.php @@ -557,7 +557,7 @@ class CRM_Core_Resources { public function setCacheCode($value) { $this->cacheCode = $value; if ($this->cacheCodeKey) { - CRM_Core_BAO_Setting::setItem($value, CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, $this->cacheCodeKey); + Civi::settings()->set($this->cacheCodeKey, $value); } return $this; } diff --git a/CRM/Upgrade/Incremental/php/FourSeven.php b/CRM/Upgrade/Incremental/php/FourSeven.php index d9c9b411a2..90112b35c6 100644 --- a/CRM/Upgrade/Incremental/php/FourSeven.php +++ b/CRM/Upgrade/Incremental/php/FourSeven.php @@ -134,7 +134,7 @@ class CRM_Upgrade_Incremental_php_FourSeven extends CRM_Upgrade_Incremental_Base // Previously a numeric value indicated one of 4 wysiwyg editors shipped in core, and no value indicated 'Textarea' // Now the options are "Textarea", "CKEditor", and the rest have been dropped from core. $newEditor = $editorID ? "CKEditor" : "Textarea"; - CRM_Core_BAO_Setting::setItem($newEditor, CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'editor_id'); + Civi::settings()->set('editor_id', $newEditor); return $editorID; } diff --git a/tests/phpunit/CRM/Core/BAO/SettingTest.php b/tests/phpunit/CRM/Core/BAO/SettingTest.php index 48f140d5b8..aeb3a040fa 100644 --- a/tests/phpunit/CRM/Core/BAO/SettingTest.php +++ b/tests/phpunit/CRM/Core/BAO/SettingTest.php @@ -87,7 +87,7 @@ class CRM_Core_BAO_SettingTest extends CiviUnitTestCase { Civi::service('settings_manager')->useMandatory(); $values = CRM_Core_BAO_Setting::getItem('Test Preferences'); $this->assertEquals('/test/override', $values['overrideSetting']); - CRM_Core_BAO_Setting::setItem('/test/database', 'Test Preferences', 'databaseSetting'); + Civi::settings()->set('databaseSetting', '/test/database'); $values = CRM_Core_BAO_Setting::getItem('Test Preferences'); $this->assertEquals('/test/override', $values['overrideSetting']); $this->assertEquals('/test/database', $values['databaseSetting']); @@ -153,22 +153,14 @@ class CRM_Core_BAO_SettingTest extends CiviUnitTestCase { // set initial value $_testOnChange_hookCalls = array('count' => 0); - CRM_Core_BAO_Setting::setItem( - array('First', 'Value'), - 'CiviCRM Preferences', - 'onChangeExample' - ); + Civi::settings()->set('onChangeExample', array('First', 'Value')); $this->assertEquals(1, $_testOnChange_hookCalls['count']); $this->assertEquals(array('First', 'Value'), $_testOnChange_hookCalls['newValue']); $this->assertEquals('List of Components', $_testOnChange_hookCalls['metadata']['title']); // change value $_testOnChange_hookCalls = array('count' => 0); - CRM_Core_BAO_Setting::setItem( - array('Second', 'Value'), - 'CiviCRM Preferences', - 'onChangeExample' - ); + Civi::settings()->set('onChangeExample', array('Second', 'Value')); $this->assertEquals(1, $_testOnChange_hookCalls['count']); $this->assertEquals(array('First', 'Value'), $_testOnChange_hookCalls['oldValue']); $this->assertEquals(array('Second', 'Value'), $_testOnChange_hookCalls['newValue']); diff --git a/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php b/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php index c766c40499..6803db78b9 100644 --- a/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php +++ b/tests/phpunit/CRM/Core/Payment/AuthorizeNetTest.php @@ -165,10 +165,10 @@ class CRM_Core_Payment_AuthorizeNetTest extends CiviUnitTestCase { ); // turn verifySSL off - CRM_Core_BAO_Setting::setItem('0', CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'); + Civi::settings()->set('verifySSL', '0'); $this->doPayment($params); // turn verifySSL on - CRM_Core_BAO_Setting::setItem('0', CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'); + Civi::settings()->set('verifySSL', '0'); // if subscription was successful, processor_id / subscription-id must not be null $this->assertDBNotNull('CRM_Contribute_DAO_ContributionRecur', $recur->id, 'processor_id', @@ -306,10 +306,10 @@ class CRM_Core_Payment_AuthorizeNetTest extends CiviUnitTestCase { $smarty->assign('subscriptionType', 'create'); // turn verifySSL off - CRM_Core_BAO_Setting::setItem('0', CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'); + Civi::settings()->set('verifySSL', '0'); $this->doPayment($params); // turn verifySSL on - CRM_Core_BAO_Setting::setItem('0', CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL'); + Civi::settings()->set('verifySSL', '0'); // if subscription was successful, processor_id / subscription-id must not be null $this->assertDBNotNull('CRM_Contribute_DAO_ContributionRecur', $recur->id, 'processor_id', diff --git a/tests/phpunit/CiviTest/CiviMailUtils.php b/tests/phpunit/CiviTest/CiviMailUtils.php index ca3d7eb392..854974f185 100644 --- a/tests/phpunit/CiviTest/CiviMailUtils.php +++ b/tests/phpunit/CiviTest/CiviMailUtils.php @@ -106,10 +106,7 @@ class CiviMailUtils extends PHPUnit_Framework_TestCase { $this->_outBound_option = $mailingBackend['outBound_option']; $mailingBackend['outBound_option'] = CRM_Mailing_Config::OUTBOUND_OPTION_REDIRECT_TO_DB; - CRM_Core_BAO_Setting::setItem($mailingBackend, - CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, - 'mailing_backend' - ); + Civi::settings()->set('mailing_backend', $mailingBackend); $mailingBackend = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, 'mailing_backend' @@ -138,10 +135,7 @@ class CiviMailUtils extends PHPUnit_Framework_TestCase { $mailingBackend['outBound_option'] = $this->_outBound_option; - CRM_Core_BAO_Setting::setItem($mailingBackend, - CRM_Core_BAO_Setting::MAILING_PREFERENCES_NAME, - 'mailing_backend' - ); + Civi::settings()->set('mailing_backend', $mailingBackend); } } diff --git a/tests/phpunit/api/v3/TaxContributionPageTest.php b/tests/phpunit/api/v3/TaxContributionPageTest.php index 51aab4e337..90e48b54ae 100644 --- a/tests/phpunit/api/v3/TaxContributionPageTest.php +++ b/tests/phpunit/api/v3/TaxContributionPageTest.php @@ -154,7 +154,7 @@ class api_v3_TaxContributionPageTest extends CiviUnitTestCase { 'tax_term' => 'Sales Tax', 'tax_display_settings' => 'Inclusive', ); - $setInvoiceSettings = CRM_Core_BAO_Setting::setItem($contributeSetting, CRM_Core_BAO_Setting::CONTRIBUTE_PREFERENCES_NAME, 'contribution_invoice_settings'); + $setInvoiceSettings = Civi::settings()->set('contribution_invoice_settings', $contributeSetting); // Payment Processor $paymentProceParams = array( -- 2.25.1