Flatten fix

[aydun]

Overview

Bug fix for CRM_Utils_Array::flatten() extracted from #12012 Flatten should restructure the array and return all original keys, not filter based on value.

Includes a test

Before

Keys with empty values are not in the flattened array

After

Keys with empty values are included in the flattened array

Comments

There are only a few uses of this function in the codebase. So far as I can see, none of them assume empty values will be filtered out.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[eileenmcnaughton]

test this please

[eileenmcnaughton]

@aydun these are the places that call that function. I think it's logical that tokens should process empty tokens too and I can't see why any of the DAO / handler places would be empty.

I am a bit less sure about the dedupe call. I feel like the change is likely OK but could have unexpected consequences so I think it makes sense to add an array_filter call in the dedupe path

My suggestion is always to do any wrangling as close to where it is used as possible & in this case the array is passed through to a function that is only called from one place - so I would go with

diff --git a/CRM/Dedupe/Finder.php b/CRM/Dedupe/Finder.php
index 45689b9b2c..1929b9e38b 100644
--- a/CRM/Dedupe/Finder.php
+++ b/CRM/Dedupe/Finder.php
@@ -125,6 +125,8 @@ class CRM_Dedupe_Finder {
     if (!$params) {
       return array();
     }
+    // This may no longer be required - see https://github.com/civicrm/civicrm-core/pull/13176
+    $params = array_filter($params);
 
     $foundByID = FALSE;
     if ($ruleGroupID) {

[eileenmcnaughton]

let's try again - test fails are

	Test Result (3 failures / ±0)Civi\API\Subscriber\WhitelistSubscriberTest::testEach.testEach with data set #25Civi\API\Subscriber\WhitelistSubscriberTest::testEach.testEach with data set #26Civi\API\Subscriber\WhitelistSubscriberTest::testEach.testEach with data set #28

[eileenmcnaughton]

test this please

[aydun]

Thanks @eileenmcnaughton I've added that change to CRM/Dedupe/Finder.php

[eileenmcnaughton]

test this please

[aydun]

test this please

[aydun]

@eileenmcnaughton Are you ok to merge this now?