Merge pull request #12192 from eileenmcnaughton/utils

Further additional utility function for handling odd array structure

CRM/Utils/Array.php

@@ -1197,4 +1197,20 @@ public static function recursiveValue($array, $path, $default = NULL) {
     return $array;
   }
 
+  /**
+   * Append the value to the array using the key provided.
+   *
+   * e.g if value is 'llama' & path is [0, 'email', 'location'] result will be
+   * [0 => ['email' => ['location' => 'llama']]
+   *
+   * @param $path
+   * @param $value
+   *
+   * @return array
+   */
+  public static function recursiveBuild($path, $value) {
+    $arrayKey = array_shift($path);
+    return [$arrayKey => (empty($path) ? $value : self::recursiveBuild($path, $value))];
+  }
+
 }

tests/phpunit/CRM/Utils/ArrayTest.php

@@ -298,4 +298,28 @@ public function testRecursiveValue($array, $path, $default, $expected) {
     $this->assertEquals($expected, $result);
   }
 
+  /**
+   * Get values for build test.
+   */
+  public function getBuildValueExamples() {
+    return [
+      [
+        [0, 'email', 2, 'location'], [0 => ['email' => [2 => ['location' => 'llama']]]]
+      ]
+    ];
+  }
+
+  /**
+   * Test the build recursive function.
+   *
+   * @param $path
+   * @param $expected
+   *
+   * @dataProvider getBuildValueExamples
+   */
+  public function testBuildRecursiveValue($path, $expected) {
+    $result = CRM_Utils_Array::recursiveBuild($path, 'llama');
+    $this->assertEquals($expected, $result);
+  }
+
 }