Merge branch 'release/0.3.3'

Author: cdtweb

README.md

@@ -77,6 +77,10 @@ Alias for `toArray()`.
 
 Returns all items in the collection as an associative array.
 
+##### `flatten() : array`
+
+Flatten all items in the collection using dot notation.
+
 ### \Noname\Common\Validator
 
 Use `Validator` to validate your data based on a set of rules.
@@ -238,4 +242,14 @@ Validator::isstring('Hello world!');
 
 // This is valid because 'String' starts with uppercased letter.
 Validator::isString('Hello world!');
- ```
+ ```
+ 
+### `\Noname\Common\Arr`
+
+A helper library for working with arrays. 
+
+#### Arr Methods
+
+##### `Arr::flatten(array $array, string $separator = '.', string $prepend = '') : array`
+
+Flatten an associative array using a custom separator.

composer.json

@@ -1,15 +1,15 @@
 {
     "name": "nonamephp/php7-common",
     "description": "A collection of common PHP 7 libraries",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "license": "MIT",
     "authors": [
         {
             "name": "Clint Tyler",
             "email": "ctyler@cdtwebsolutions.com"
         }
     ],
-    "keywords": ["noname", "nonamephp", "common", "collection", "validator"],
+    "keywords": ["noname", "nonamephp", "common", "collection", "validator", "array"],
     "homepage": "https://github.com/nonamephp/php7-common",
     "require": {
         "php": ">=7.0"

src/Arr.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+namespace Noname\Common;
+
+/**
+ * Class Arr
+ *
+ * @package Noname\Common
+ */
+class Arr
+{
+    /**
+     * Flatten an associative array using a custom separator.
+     *
+     * By default this method will use a dot (.) as the separator.
+     *
+     * @param array $array
+     * @param string $separator
+     * @param string $prepend
+     * @return array
+     */
+    public static function flatten(array $array, string $separator = '.', string $prepend = ''): array
+    {
+        $flatArray = [];
+
+        foreach ($array as $key => $value) {
+            if (is_array($value) && !empty($value)) {
+                $flatArray += self::flatten($value, $separator, $prepend . $key . $separator);
+            } else {
+                $flatArray[$prepend . $key] = $value;
+            }
+        }
+
+        return $flatArray;
+    }
+}

src/Collection.php

@@ -1,4 +1,4 @@
-<?php declare(strict_types=1);
+<?php declare(strict_types = 1);
 namespace Noname\Common;
 
 use ArrayAccess;
@@ -116,7 +116,7 @@ public function pluck($key, $default = null)
      *
      * @return array
      */
-    public function all() : array
+    public function all(): array
     {
         return $this->toArray();
     }
@@ -126,7 +126,7 @@ public function all() : array
      *
      * @return array
      */
-    public function keys() : array
+    public function keys(): array
     {
         return array_keys($this->items);
     }
@@ -136,7 +136,7 @@ public function keys() : array
      *
      * @return array
      */
-    public function values() : array
+    public function values(): array
     {
         return array_values($this->items);
     }
@@ -147,7 +147,7 @@ public function values() : array
      * @param string $key
      * @return boolean
      */
-    public function has($key) : bool
+    public function has($key): bool
     {
         return isset($this->items[$key]);
     }
@@ -161,7 +161,7 @@ public function has($key) : bool
      * @return boolean
      * @throws \InvalidArgumentException
      */
-    public function is($key, $value, $operator = null) : bool
+    public function is($key, $value, $operator = null): bool
     {
         $keyValue = $this->get($key);
 
@@ -207,11 +207,21 @@ public function destroy()
      *
      * @return array
      */
-    public function toArray() : array
+    public function toArray(): array
     {
         return $this->items;
     }
 
+    /**
+     * Flatten collection with dot (.) separator.
+     *
+     * @return array
+     */
+    public function flatten(): array
+    {
+        return Arr::flatten($this->items);
+    }
+
     ///////////////////////////////////
     // IteratorAggregate Methods
 

tests/ArrTest.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+namespace Noname\Common;
+
+class ArrTest extends \PHPUnit_Framework_TestCase
+{
+    public function testFlatten()
+    {
+        $array = ['a' => 'b', 'c' => ['d' => 'e', 'f' => ['g' => [1, 2, 3 => []]]]];
+
+        $flatArray = Arr::flatten($array);
+
+        // Check for keys
+        $this->assertArrayHasKey('a', $flatArray);
+        $this->assertArrayHasKey('c.d', $flatArray);
+        $this->assertArrayHasKey('c.f.g.0', $flatArray);
+        $this->assertArrayHasKey('c.f.g.1', $flatArray);
+        $this->assertArrayHasKey('c.f.g.3', $flatArray);
+
+        // Check for values
+        $this->assertEquals('b', $flatArray['a']);
+        $this->assertEquals('e', $flatArray['c.d']);
+        $this->assertEquals(1, $flatArray['c.f.g.0']);
+        $this->assertEquals(2, $flatArray['c.f.g.1']);
+        $this->assertEquals([], $flatArray['c.f.g.3']);
+    }
+}