diff --git a/CRM/Contribute/BAO/Contribution.php b/CRM/Contribute/BAO/Contribution.php
index 8f1fd8db46e51045e8cf1b3fbaaefcc41c151237..2afb3597fc6a77ed25f7ea50630c6ed178f2cd85 100644
--- a/CRM/Contribute/BAO/Contribution.php
+++ b/CRM/Contribute/BAO/Contribution.php
@@ -166,7 +166,7 @@ class CRM_Contribute_BAO_Contribution extends CRM_Contribute_DAO_Contribution {
if (!$contributionID
&& CRM_Utils_Array::value('membership_id', $params)
- && self::checkContributeSettings('deferred_revenue_enabled')
+ && Civi::settings()->get('deferred_revenue_enabled')
) {
$memberStartDate = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $params['membership_id'], 'start_date');
if ($memberStartDate) {
@@ -5562,7 +5562,7 @@ LIMIT 1;";
* @return null
*/
public static function recordAlwaysAccountsReceivable(&$trxnParams, $contributionParams) {
- if (!self::checkContributeSettings('always_post_to_accounts_receivable')) {
+ if (!Civi::settings()->get('always_post_to_accounts_receivable')) {
return NULL;
}
$statusId = $contributionParams['contribution']->contribution_status_id;
diff --git a/CRM/Contribute/Form/Contribution.php b/CRM/Contribute/Form/Contribution.php
index ab46198a0b7aaf84a2e5be3730a4790a9cc0dbcc..5258258aedd2b8c35412cfe79102e2160159c775 100644
--- a/CRM/Contribute/Form/Contribution.php
+++ b/CRM/Contribute/Form/Contribution.php
@@ -692,7 +692,7 @@ class CRM_Contribute_Form_Contribution extends CRM_Contribute_Form_AbstractEditP
}
// CRM-16189, add Revenue Recognition Date
- if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
$revenueDate = $this->add('date', 'revenue_recognition_date', ts('Revenue Recognition Date'), CRM_Core_SelectValues::date(NULL, 'M Y', NULL, 5));
if ($this->_id && !CRM_Contribute_BAO_Contribution::allowUpdateRevenueRecognitionDate($this->_id)) {
$revenueDate->freeze();
diff --git a/CRM/Event/Form/ManageEvent/Fee.php b/CRM/Event/Form/ManageEvent/Fee.php
index 3a02919e228bd67f8a84a0e82dbda266f13686ba..ddc1c2da065fec87d9e8aa72b922785207cd76bc 100644
--- a/CRM/Event/Form/ManageEvent/Fee.php
+++ b/CRM/Event/Form/ManageEvent/Fee.php
@@ -374,7 +374,7 @@ class CRM_Event_Form_ManageEvent_Fee extends CRM_Event_Form_ManageEvent {
$this->addElement('submit', $this->getButtonName('submit'), ts('Add Discount Set to Fee Table'),
['class' => 'crm-form-submit cancel']
);
- if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
$deferredFinancialType = CRM_Financial_BAO_FinancialAccount::getDeferredFinancialType();
$this->assign('deferredFinancialType', array_keys($deferredFinancialType));
}
diff --git a/CRM/Event/Form/Participant.php b/CRM/Event/Form/Participant.php
index 0b0b31e0dcf2ff42c5874882f8d7ae53d5253b41..3cd49af6c1998182303af86afe6c95f8a4ffbfa5 100644
--- a/CRM/Event/Form/Participant.php
+++ b/CRM/Event/Form/Participant.php
@@ -1002,7 +1002,7 @@ class CRM_Event_Form_Participant extends CRM_Contribute_Form_AbstractEditPayment
$contributionParams = ['skipCleanMoney' => TRUE];
$lineItem = [];
$additionalParticipantDetails = [];
- if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
$eventStartDate = CRM_Core_DAO::getFieldValue('CRM_Event_DAO_Event', $this->_eventId, 'start_date');
if (strtotime($eventStartDate) > strtotime(date('Ymt'))) {
$contributionParams['revenue_recognition_date'] = date('Ymd', strtotime($eventStartDate));
diff --git a/CRM/Event/Form/Registration/Confirm.php b/CRM/Event/Form/Registration/Confirm.php
index bc800a62a5d4f61c6389efbfae848c577f0376a4..8bebdb1e6ab47a7e09538c6543aa4c8cc3845872 100644
--- a/CRM/Event/Form/Registration/Confirm.php
+++ b/CRM/Event/Form/Registration/Confirm.php
@@ -1052,7 +1052,7 @@ class CRM_Event_Form_Registration_Confirm extends CRM_Event_Form_Registration {
);
}
- if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
$eventStartDate = CRM_Utils_Array::value(
'start_date',
CRM_Utils_Array::value(
diff --git a/CRM/Financial/BAO/FinancialAccount.php b/CRM/Financial/BAO/FinancialAccount.php
index 02ff4d9de89dd0440b1c3d3afafa92712ea66a26..c8f33573705bddb7a493a7e4964308ccf38ddc01 100644
--- a/CRM/Financial/BAO/FinancialAccount.php
+++ b/CRM/Financial/BAO/FinancialAccount.php
@@ -379,7 +379,7 @@ LIMIT 1";
*
*/
public static function checkFinancialTypeHasDeferred($params, $contributionID = NULL, $priceSetFields = NULL) {
- if (!CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (!Civi::settings()->get('deferred_revenue_enabled')) {
return FALSE;
}
$recognitionDate = CRM_Utils_Array::value('revenue_recognition_date', $params);
diff --git a/CRM/Member/Form/MembershipType.php b/CRM/Member/Form/MembershipType.php
index 3e1c01588ee3462f2092590f7907cdffe2428a4a..1ffafe2a33247fc78714b7d38f5156ac5cea8bfc 100644
--- a/CRM/Member/Form/MembershipType.php
+++ b/CRM/Member/Form/MembershipType.php
@@ -312,7 +312,7 @@ class CRM_Member_Form_MembershipType extends CRM_Member_Form_MembershipConfig {
$this->assign('membershipTypeId', $this->_id);
- if (CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled')) {
+ if (Civi::settings()->get('deferred_revenue_enabled')) {
$deferredFinancialType = CRM_Financial_BAO_FinancialAccount::getDeferredFinancialType();
$this->assign('deferredFinancialType', array_keys($deferredFinancialType));
}
diff --git a/CRM/Upgrade/Incremental/Base.php b/CRM/Upgrade/Incremental/Base.php
index c787ca4ac2cd683ad702db5f2bf98948f5f4a328..5145be10721100e7bb5c344a2ef6f1c3c78ca89b 100644
--- a/CRM/Upgrade/Incremental/Base.php
+++ b/CRM/Upgrade/Incremental/Base.php
@@ -196,6 +196,29 @@ class CRM_Upgrade_Incremental_Base {
}
+ /**
+ * Re-save any valid values from contribute settings into the normal setting
+ * format.
+ *
+ * We render the array of contribution_invoice_settings and any that have
+ * metadata defined we add to the correct key. This is safe to run even if no
+ * settings are to be converted, per the test in
+ * testConvertUpgradeContributeSettings.
+ *
+ * @param $ctx
+ *
+ * @return bool
+ */
+ public static function updateContributeSettings($ctx) {
+ $settings = Civi::settings()->get('contribution_invoice_settings');
+ $metadata = \Civi\Core\SettingsMetadata::getMetadata();
+ $conversions = array_intersect_key((array) $settings, $metadata);
+ foreach ($conversions as $key => $conversion) {
+ Civi::settings()->set($key, $conversion);
+ }
+ return TRUE;
+ }
+
/**
* Do any relevant smart group updates.
*
diff --git a/CRM/Upgrade/Incremental/php/FiveFifteen.php b/CRM/Upgrade/Incremental/php/FiveFifteen.php
index 39f1b1bd7c9c6f621de9e9929f231534b3387401..2cfb6a2d3396d1d8fb7b2eafed469d203acc363e 100644
--- a/CRM/Upgrade/Incremental/php/FiveFifteen.php
+++ b/CRM/Upgrade/Incremental/php/FiveFifteen.php
@@ -67,21 +67,14 @@ class CRM_Upgrade_Incremental_php_FiveFifteen extends CRM_Upgrade_Incremental_Ba
* (change the x in the function name):
*/
- // /**
- // * Upgrade function.
- // *
- // * @param string $rev
- // */
- // public function upgrade_5_0_x($rev) {
- // $this->addTask(ts('Upgrade DB to %1: SQL', array(1 => $rev)), 'runSql', $rev);
- // $this->addTask('Do the foo change', 'taskFoo', ...);
- // // Additional tasks here...
- // // Note: do not use ts() in the addTask description because it adds unnecessary strings to transifex.
- // // The above is an exception because 'Upgrade DB to %1: SQL' is generic & reusable.
- // }
-
- // public static function taskFoo(CRM_Queue_TaskContext $ctx, ...) {
- // return TRUE;
- // }
+ /**
+ * Upgrade function.
+ *
+ * @param string $rev
+ */
+ public function upgrade_5_15_alpha1($rev) {
+ $this->addTask(ts('Upgrade DB to %1: SQL', [1 => $rev]), 'runSql', $rev);
+ $this->addTask('Fix errant deferred revenue settings', 'updateContributeSettings');
+ }
}
diff --git a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php
index 44505f9f462cfedca3b41617321f30815f4231d3..a453d51d754d9a67f317c84f20fdaa0c1b2d4240 100644
--- a/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php
+++ b/tests/phpunit/CRM/Contribute/BAO/ContributionTest.php
@@ -999,22 +999,6 @@ WHERE eft.entity_id = %1 AND ft.to_financial_account_id <> %2";
$this->assertEquals("$ 200.00 - STUDENT", $activity->subject, 'Check for total amount in activity.');
}
- /**
- * Test checkContributeSettings.
- */
- public function testCheckContributeSettings() {
- $settings = CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled');
- $this->assertNull($settings);
- $params = array(
- 'contribution_invoice_settings' => array(
- 'deferred_revenue_enabled' => '1',
- ),
- );
- $this->callAPISuccess('Setting', 'create', $params);
- $settings = CRM_Contribute_BAO_Contribution::checkContributeSettings('deferred_revenue_enabled');
- $this->assertEquals($settings, 1, 'Check for settings has failed');
- }
-
/**
* Test allowUpdateRevenueRecognitionDate.
*/
diff --git a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
index 6f2851a98af33ed15ace64f4c4167757cf772a09..1bd7a387e1deb977b2a7400c8c1d57cf515cdf21 100644
--- a/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
+++ b/tests/phpunit/CRM/Financial/BAO/FinancialAccountTest.php
@@ -275,8 +275,8 @@ class CRM_Financial_BAO_FinancialAccountTest extends CiviUnitTestCase {
* Test for validating financial type has deferred revenue account relationship.
*/
public function testcheckFinancialTypeHasDeferred() {
- Civi::settings()->set('contribution_invoice_settings', array('deferred_revenue_enabled' => '1'));
- $params = array();
+ Civi::settings()->set('deferred_revenue_enabled', 1);
+ $params = [];
$valid = CRM_Financial_BAO_FinancialAccount::checkFinancialTypeHasDeferred($params);
$this->assertFalse($valid, "This should have been false");
$cid = $this->individualCreate();
diff --git a/tests/phpunit/CRM/Upgrade/Incremental/BaseTest.php b/tests/phpunit/CRM/Upgrade/Incremental/BaseTest.php
index 74dbaca6ab43ac27ee9f9b850e7a83c018044c4d..a990e124fcedf3b3ec81d83853bfbadc8ec092ce 100644
--- a/tests/phpunit/CRM/Upgrade/Incremental/BaseTest.php
+++ b/tests/phpunit/CRM/Upgrade/Incremental/BaseTest.php
@@ -151,6 +151,8 @@ class CRM_Upgrade_Incremental_BaseTest extends CiviUnitTestCase {
/**
* Test renaming multiple fields.
+ *
+ * @throws Exception
*/
public function testRenameFields() {
$this->callAPISuccess('SavedSearch', 'create', [
@@ -169,4 +171,15 @@ class CRM_Upgrade_Incremental_BaseTest extends CiviUnitTestCase {
$this->assertEquals('activity_date_time_relative', $savedSearch['form_values'][1][0]);
}
+ /**
+ * Test that a mis-saved variable in 'contribute settings' can be converted to a
+ * 'proper' setting.
+ */
+ public function testConvertUpgradeContributeSettings() {
+ Civi::settings()->set('contribution_invoice_settings', ['foo' => 'bar', 'deferred_revenue_enabled' => 1]);
+ $this->assertEquals(0, Civi::settings()->get('deferred_revenue_enabled'));
+ CRM_Upgrade_Incremental_Base::updateContributeSettings(NULL, 5.1);
+ $this->assertEquals(1, Civi::settings()->get('deferred_revenue_enabled'));
+ }
+
}