From d6f1584f5d789c13ea9c68998cf93cf9b5625396 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Tue, 10 Jul 2018 22:23:29 -0400
Subject: [PATCH] Cleanup redundant array functions

---
 CRM/Utils/Array.php | 90 ++++++++++++++++++++++-----------------------
 1 file changed, 44 insertions(+), 46 deletions(-)

diff --git a/CRM/Utils/Array.php b/CRM/Utils/Array.php
index a9d6cdd07e..99a7fd7018 100644
--- a/CRM/Utils/Array.php
+++ b/CRM/Utils/Array.php
@@ -965,38 +965,58 @@ class CRM_Utils_Array {
   }
 
   /**
-   * Get a single value from an array-tre.
+   * Get a single value from an array-tree.
    *
-   * @param array $arr
-   *   Ex: array('foo'=>array('bar'=>123)).
-   * @param array $pathParts
-   *   Ex: array('foo',bar').
-   * @return mixed|NULL
+   * @param array $values
+   *   Ex: ['foo' => ['bar' => 123]].
+   * @param array $path
+   *   Ex: ['foo', 'bar'].
+   * @param mixed $default
+   * @return mixed
    *   Ex 123.
    */
-  public static function pathGet($arr, $pathParts) {
-    $r = $arr;
-    foreach ($pathParts as $part) {
-      if (!isset($r[$part])) {
-        return NULL;
+  public static function pathGet($values, $path, $default = NULL) {
+    foreach ($path as $key) {
+      if (!is_array($values) || !isset($values[$key])) {
+        return $default;
       }
-      $r = $r[$part];
+      $values = $values[$key];
     }
-    return $r;
+    return $values;
+  }
+
+  /**
+   * Check if a key isset which may be several layers deep.
+   *
+   * This is a helper for when the calling function does not know how many layers deep
+   * the path array is so cannot easily check.
+   *
+   * @param array $values
+   * @param array $path
+   * @return bool
+   */
+  public static function pathIsset($values, $path) {
+    foreach ($path as $key) {
+      if (!is_array($values) || !isset($values[$key])) {
+        return FALSE;
+      }
+      $values = $values[$key];
+    }
+    return TRUE;
   }
 
   /**
    * Set a single value in an array tree.
    *
-   * @param array $arr
-   *   Ex: array('foo'=>array('bar'=>123)).
+   * @param array $values
+   *   Ex: ['foo' => ['bar' => 123]].
    * @param array $pathParts
-   *   Ex: array('foo',bar').
+   *   Ex: ['foo', 'bar'].
    * @param $value
    *   Ex: 456.
    */
-  public static function pathSet(&$arr, $pathParts, $value) {
-    $r = &$arr;
+  public static function pathSet(&$values, $pathParts, $value) {
+    $r = &$values;
     $last = array_pop($pathParts);
     foreach ($pathParts as $part) {
       if (!isset($r[$part])) {
@@ -1161,16 +1181,10 @@ class CRM_Utils_Array {
    * @param array $array
    * @param array $path
    * @return bool
-   * @throws \CRM_Core_Exception
+   * @deprecated
    */
   public static function recursiveIsset($array, $path) {
-    foreach ($path as $key) {
-      if (!is_array($array) || !isset($array[$key])) {
-        return FALSE;
-      }
-      $array = $array[$key];
-    }
-    return TRUE;
+    return self::pathIsset($array, $path);
   }
 
   /**
@@ -1185,16 +1199,10 @@ class CRM_Utils_Array {
    * @param mixed $default
    *   Value to return if not found.
    * @return bool
-   * @throws \CRM_Core_Exception
+   * @deprecated
    */
   public static function recursiveValue($array, $path, $default = NULL) {
-    foreach ($path as $key) {
-      if (!is_array($array) || !isset($array[$key])) {
-        return $default;
-      }
-      $array = $array[$key];
-    }
-    return $array;
+    return self::pathGet($array, $path, $default);
   }
 
   /**
@@ -1208,20 +1216,10 @@ class CRM_Utils_Array {
    * @param array $source
    *
    * @return array
+   * @deprecated
    */
   public static function recursiveBuild($path, $value, $source = []) {
-    $arrayKey = array_shift($path);
-    // Recurse through array keys
-    if ($path) {
-      if (!isset($source[$arrayKey])) {
-        $source[$arrayKey] = [];
-      }
-      $source[$arrayKey] = self::recursiveBuild($path, $value, $source[$arrayKey]);
-    }
-    // Final iteration
-    else {
-      $source[$arrayKey] = $value;
-    }
+    self::pathSet($source, $path, $value);
     return $source;
   }
 
-- 
2.25.1