Merge pull request #83 from Hi-Folks/feat/nested-get

get() supports nested arrays

Author: roberto-butti

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.2 - 2024-05-24
+- The Arr `get()` method supports 'dot' (or custom) notation for nested arrays for example $arr->get('first-level.second-level.third-level')
+- The Arr `get()` method supports the default value
+
 ## 1.0.1 - 2024-05-23
 Fine-tuning release: removing version from composer.json and fixing changelog
 

README.md

@@ -63,6 +63,43 @@ The Arr class provides some methods:
 - set(): ability to set an element to the array with a specific key
 - unset(): ability to unset an element by the key
 
+### The `get()` method
+The `get()` method supports keys with the dot (or custom) notation for retrieving values from nested arrays.
+For example:
+
+```php
+$fruits = Arr::make([
+    'green' => [
+        'kiwi' => '🥝',
+        'mango' => '🥭'
+    ],
+    'red' => [
+        'strawberry' => '🍓',
+        'apple' => '🍎'
+    ],
+    'yellow' => [
+        'lemon' => '🍋',
+        'banana' => '🍌',
+    ]
+]);
+$fruits->get('red'); // 🍓,🍎
+$fruits->get('red.strawberry'); // 🍓
+```
+
+You can customize the notation with a different character:
+
+```php
+$fruits->get('red#strawberry', charNestedKey: '#'); // 🍓
+```
+You can define a default value in the case the key doesn't exist:
+
+```php
+$fruits->get('red#somestrangefruit',
+'🫠', '#'); // 🫠
+```
+
+
+
 ## Table class
 Table class allows you to manage bi dimensional array, something like:
 ```

examples/cheatsheet.php

@@ -161,7 +161,7 @@
 // Extract keys with keys()
 $fruits = Arr::make([
     'kiwi' => '🥝',
-    'fragola' => '🍓',
+    'strawberry' => '🍓',
     'lemon' => '🍋',
     'mango' => '🥭',
     'apple' => '🍎',
@@ -192,7 +192,7 @@
 // Extract entries with entries()
 $fruits = Arr::make([
     'kiwi' => '🥝',
-    'fragola' => '🍓',
+    'strawberry' => '🍓',
     'lemon' => '🍋',
     'mango' => '🥭',
     'apple' => '🍎',
@@ -252,6 +252,22 @@
 print_result($arr->arr());
 // ['mango' => '🥭', 'apple' => '🍎']
 
+$fruits = Arr::make([
+    'green' => [
+        'kiwi' => '🥝',
+        'mango' => '🥭'
+    ],
+    'red' => [
+        'strawberry' => '🍓',
+        'apple' => '🍎'
+    ],
+    'yellow' => [
+        'lemon' => '🍋',
+        'banana' => '🍌',
+    ]
+]);
+print_result($fruits->get('red'));
+print_result($fruits->get('red.strawberry'));
 
 
 

src/Arr.php

@@ -108,10 +108,25 @@ public function arr(): array
 
     /**
      * Get the element with $index
-     */
-    public function get(mixed $index): mixed
-    {
-        return $this->arr[$index] ?? null;
+     * @param non-empty-string $charNestedKey
+     */
+    public function get(mixed $index, mixed $defaultValue = null, string $charNestedKey = "."): mixed
+    {
+        if (is_string($index)) {
+            $indexString = strval($index);
+            if (str_contains($indexString, $charNestedKey)) {
+                $nestedValue = $this->arr;
+                foreach (explode($charNestedKey, $indexString) as $nestedKey) {
+                    if (is_array($nestedValue) && array_key_exists($nestedKey, $nestedValue)) {
+                        $nestedValue = $nestedValue[$nestedKey];
+                    } else {
+                        return $defaultValue;
+                    }
+                }
+                return $nestedValue;
+            }
+        }
+        return $this->arr[$index] ?? $defaultValue;
     }
 
     /**

tests/ArrGetTest.php

@@ -0,0 +1,43 @@
+<?php
+
+use HiFolks\DataType\Arr;
+
+it('Basic get', function (): void {
+    $arr = Arr::make(['A','B','C']);
+    expect($arr->get(1))->toBe('B');
+    expect($arr->get(4))->toBeNull();
+    expect($arr->get(4, 'AAAA'))->toBe("AAAA");
+});
+
+it('Basic nested get', function (): void {
+    $arr = Arr::make([
+        'A' => 'First',
+        'B' => ['some', 'thing'],
+        'C' => [ 'nested-item-1' => 10, 'nested-item-2' => 20],
+        'D' => []
+    ]);
+    expect($arr->get('A'))->toBe('First');
+    expect($arr->get('B'))->toBeArray();
+    expect($arr->get('B.0'))->toBe('some');
+    expect($arr->get('B.1'))->toBe('thing');
+    expect($arr->get('B.2'))->toBeNull();
+    expect($arr->get('B.2', 1234))->toBe(1234);
+    expect($arr->get('B#0', charNestedKey: '#'))->toBe('some');
+    expect($arr->get('B#1', charNestedKey: '#'))->toBe('thing');
+    expect($arr->get('B#2', charNestedKey: '#'))->toBeNull();
+    expect($arr->get('B#2', 1234, '#'))->toBe(1234);
+
+    expect($arr->get('C.0'))->toBeNull();
+    expect($arr->get('C.nested-item-1'))->toBe(10);
+    expect($arr->get('C.nested-item-2'))->toBe(20);
+    expect($arr->get('C.nested-item-2.other'))->toBeNull();
+    expect($arr->get('C.nested-item-2.other', 'zzz'))->toBe('zzz');
+    expect($arr->get('C#nested-item-2#other', 'zzz', '#'))->toBe('zzz');
+    expect($arr->get('C#nested-item-2#other', 'zzz'))->toBe('zzz');
+    expect($arr->get('C#nested-item-2', 'zzz'))->toBe('zzz');
+    expect($arr->get('C#nested-item-4', 'zzz'))->toBe('zzz');
+    expect($arr->get('D#nested-item-4', 'zzz'))->toBe('zzz');
+    expect($arr->get('D.0'))->toBeNull();
+    expect($arr->get('D', '0'))->toBeArray()->toHaveLength(0);
+
+});