Added renameKeys method

Author: robinsonjohn

CHANGELOG.md

@@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Fixed` for any bug fixes.
 - `Security` in case of vulnerabilities
 
+## [1.1.0] - 2020.11.23
+
+### Added
+
+- Added `renameKeys` method.
+
 ## [1.0.1] - 2020.08.02
 
 ### Changed

README.md

@@ -40,6 +40,7 @@ composer require bayfrontmedia/php-array-helpers
 - [missing](#missing)
 - [isMissing](#ismissing)
 - [multisort](#multisort)
+- [renameKeys](#renamekeys)
 - [query](#query)
 
 <hr />
@@ -450,6 +451,41 @@ $sorted = Arr::multisort($clients, 'first_name');
 
 <hr />
 
+### renameKeys
+
+**Description:**
+
+Rename array keys while preserving their order.
+
+**Parameters:**
+
+- `$array` (array): Original array
+- `$keys` (array): Key/value pairs to rename
+
+**Returns:**
+
+- (array)
+
+**Example:**
+
+```
+use Bayfront\ArrayHelpers\Arr;
+
+$user = [
+    'UserID' => 5,
+    'UserEmail' => '[email protected]',
+    'UserGroup' => 'Administrator'
+];
+
+$renamed = Arr::renameKeys($user, [
+    'UserID' => 'id',
+    'UserEmail' => 'email',
+    'UserGroup' => 'group'
+]);
+```
+
+<hr />
+
 ### query
 
 **Description:**

src/Arr.php

@@ -326,6 +326,38 @@ public static function multisort(array $array, string $key, bool $descending = f
 
     }
 
+    /**
+     * Rename array keys while preserving their order.
+     *
+     * @param array $array (Original array)
+     * @param array $keys (Key/value pairs to rename)
+     *
+     * @return array
+     */
+
+    public static function renameKeys(array $array, array $keys): array
+    {
+
+        $new_array = [];
+
+        foreach ($array as $k => $v) {
+
+            if (array_key_exists($k, $keys)) {
+
+                $new_array[$keys[$k]] = $v;
+
+            } else {
+
+                $new_array[$k] = $v;
+
+            }
+
+        }
+
+        return $new_array;
+
+    }
+
     /**
      * Convert array into a query string
      *