v1.0.1

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.0.1] - 2020.08.02
+
+### Changed
+
+- Corrected return type for `set()` as `void`
+
 ## [1.0.0] - 2020.07.27
 
 ### Added

README.md

@@ -18,7 +18,7 @@ John Robinson, [Bayfront Media](https://www.bayfrontmedia.com)
 
 ## Requirements
 
-* PHP > 7.1.0
+* PHP >= 7.1.0
 
 ## Installation
 
@@ -124,7 +124,7 @@ Set an array item to a given value using "dot" notation.
 
 **Returns:**
 
-- (array)
+- (void)
 
 **Example:**
 
@@ -138,7 +138,7 @@ $array = [
     ],
 ];
 
-$array = Arr::set($array, 'name.middle_name', 'Middle');
+Arr::set($array, 'name.middle_name', 'Middle');
 ```
 
 <hr />
@@ -220,7 +220,7 @@ Returns an array of values for a given key from an array using "dot" notation.
 
 - `$array` (array): Original array
 - `$value` (string): Value to return in "dot" notation
-- `$key = NULL` (string): Optionally how to key the returned array in "dot" notation
+- `$key = NULL` (string|null): Optionally how to key the returned array in "dot" notation
 
 **Returns:**
 

composer.json

@@ -3,7 +3,7 @@
   "description": "Helper class to provide useful array functions.",
   "homepage": "https://github.com/bayfrontmedia/php-array-helpers",
   "license" : "MIT",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "library",
   "keywords": [
     "php",

composer.lock

@@ -1,15 +1,9 @@
 <?php
 /**
- * Helper class to provide useful array functions
- *
- * Heavily inspired by: https://laravel.com/docs/7.x/helpers
- * See: https://github.com/laravel/framework/blob/5.8/src/Illuminate/Support/Arr.php
- *
- * @version     1.0.0
- * @link        https://github.com/bayfrontmedia/php-array-helpers
- * @license     MIT https://opensource.org/licenses/MIT
- * @copyright   2020 Bayfront Media https://www.bayfrontmedia.com
- * @author      John Robinson <[email protected]>
+ * @package php-array-helpers
+ * @link https://github.com/bayfrontmedia/php-array-helpers
+ * @author John Robinson <[email protected]>
+ * @copyright 2020 Bayfront Media
  */
 
 namespace Bayfront\ArrayHelpers;
@@ -86,10 +80,10 @@ public static function undot(array $array): array
      * @param string $key (Key to set in "dot" notation)
      * @param mixed $value (Value of key)
      *
-     * @return array (Modified array)
+     * @return void
      */
 
-    public static function set(&$array, string $key, $value): array
+    public static function set(&$array, string $key, $value): void
     {
 
         $keys = explode('.', $key);
@@ -116,8 +110,6 @@ public static function set(&$array, string $key, $value): array
 
         $array[array_shift($keys)] = $value;
 
-        return $array;
-
     }
 
     /**
@@ -180,7 +172,7 @@ public static function get(array $array, string $key, $default = NULL)
      *
      * @param array $array (Original array)
      * @param string $value (Value to return in "dot" notation)
-     * @param string $key (Optionally how to key the returned array in "dot" notation)
+     * @param string|null $key (Optionally how to key the returned array in "dot" notation)
      *
      * @return array
      */