initial commit

Author: Alaa Sarhan

.gitignore

@@ -0,0 +1,2 @@
+/vendor/
+composer.lock

composer.json

@@ -0,0 +1,29 @@
+{
+    "name": "sarhan/php-flatten",
+    "description": "Flattens multidimensional arrays into one dimensional array.",
+    "type": "library",
+    "keywords": ["array", "flatten", "arrays"],
+    "homepage": "https://github.com/AlaaSarhan/php-flatten",
+    "license": "LGPL-3.0",
+    "authors": [
+        {
+            "name": "Alaa Sarhan",
+            "email": "sarhan.alaa@gmail.com"
+        }
+    ],
+    "autoload": {
+        "psr-4": {
+            "Sarhan\\": "./src/"
+        }
+    },
+    "minimum-stability": "stable",
+    "require": {
+        "php": ">=5.5"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^5.5"
+    },
+    "scripts": {
+        "test": "phpunit"
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<phpunit bootstrap="./vendor/autoload.php">
+
+    <testsuites>
+        <testsuite name="Flatten">
+            <directory>./test</directory>
+        </testsuite>
+    </testsuites>
+
+</phpunit>

src/Flatten.php

@@ -0,0 +1,37 @@
+<?php
+namespace Sarhan;
+
+class Flatten
+{
+    public static function flatten($var, $separator = '.', $prefix = '')
+    {
+        if (!self::canTraverse($var)) {
+            return $var;
+        }
+        
+        $flattened = [];
+        foreach (self::flattenGenerator($var, $separator, $prefix) as $key => $value) {
+            $flattened[$key] = $value;
+        }
+        return $flattened;
+    }
+    
+    private static function flattenGenerator($var, $separator, $prefix = '')
+    {
+        if (self::canTraverse($var)) {
+            $prefix .= (empty($prefix) ? '' : $separator);
+            foreach ($var as $key => $value) {
+                foreach (self::flattenGenerator($value, $separator, $prefix . $key) as $k => $v) {
+                    yield $k => $v;
+                }
+            }
+        } else {
+            yield $prefix => $var;
+        }
+    }
+    
+    private static function canTraverse($var)
+    {
+        return is_array($var) || ($var instanceof \Traversable);
+    }
+}

test/FlattenTest.php

@@ -0,0 +1,130 @@
+<?php
+
+use PHPUnit\Framework\TestCase;
+use Sarhan\Flatten;
+
+class FlattenTest extends TestCase
+{
+    public function scalarProvider()
+    {
+        return [
+            [ null, null ],
+            [ '', '' ],
+            [ 0, 0 ],
+            [ 3.14, 3.14 ],
+            [ 'test', 'test' ],
+            [ false, false ]
+        ];
+    }
+    
+    /**
+     * @covers Flatten::flatten
+     * @dataProvider scalarProvider
+     */
+    public function testFlattenScalar($input, $expectedOutput)
+    {
+        $output = Flatten::flatten($input);
+        
+        $this->assertEquals($expectedOutput, $output);
+    }
+    
+    public function arraysProvider()
+    {
+        return [
+            [ [ ], [ ] ],
+            [ [ 0 ], [ '0' => 0 ] ],
+            [ [ 1, 2 ], [ '0' => 1, '1' => 2 ] ],
+            [
+                [ 1, 2, [ 3, 4 ] ],
+                [ '0' => 1, '1' => 2, '2.0' => 3, '2.1' => 4 ]
+            ],
+            [
+                [ 'a' => 1, 2, 'b' => [ 3, 'c' => 4 ] ],
+                [ 'a' => 1, '0' => 2, 'b.0' => 3, 'b.c' => 4 ]
+            ],
+            [
+                [ 'a' => 1, 'b' => 2, 'c' => [ 'd' => [ 3, 4 ], 'e' => [ 'f' => 5, 'g' => 6 ] ] ],
+                [ 'a' => 1, 'b' => 2, 'c.d.0' => 3, 'c.d.1' => 4, 'c.e.f' => 5, 'c.e.g' => 6 ]
+            ]
+        ];
+    }
+    
+    /**
+     * @covers Flatten::flatten
+     * @dataProvider arraysProvider
+     */
+    public function testFlattenArrays($input, $expectedOutput)
+    {
+        $output = Flatten::flatten($input);
+        
+        $this->assertEquals($expectedOutput, $output);
+    }
+    
+    public function traversablesProvider()
+    {
+        return [
+            [ new \ArrayIterator([ ]), [ ] ],
+            [ new \ArrayIterator([ 0 ]), [ '0' => 0 ] ],
+            [ new \ArrayIterator([ 1, 2 ]), [ '0' => 1, '1' => 2 ] ],
+            [
+                new \ArrayIterator([ 1, 2, [ 3, 4 ] ]),
+                [ '0' => 1, '1' => 2, '2.0' => 3, '2.1' => 4 ]
+            ],
+            [
+                new \ArrayIterator([ 'a' => 1, 2, 'b' => new \ArrayIterator([ 3, 'c' => 4 ]) ]),
+                [ 'a' => 1, '0' => 2, 'b.0' => 3, 'b.c' => 4 ]
+            ],
+            [
+                new \ArrayIterator([ 'a' => 1, 'b' => 2, 'c' => [ 'd' => [ 3, 4 ], 'e' => new \ArrayIterator([ 'f' => 5, 'g' => 6 ]) ] ]),
+                [ 'a' => 1, 'b' => 2, 'c.d.0' => 3, 'c.d.1' => 4, 'c.e.f' => 5, 'c.e.g' => 6 ]
+            ]
+        ];
+    }
+    
+    /**
+     * @covers Flatten::flatten
+     * @dataProvider traversablesProvider
+     */
+    public function testFlattenTraversable($input, $expectedOutput)
+    {
+        $output = Flatten::flatten($input);
+        $this->assertEquals($expectedOutput, $output);
+    }
+    
+    public function traversablesSeparatorPrefixProvider()
+    {
+        return [
+            [ new \ArrayIterator([ ]), '-', 'global', [ ] ],
+            [ new \ArrayIterator([ 0 ]), '-', 'global', [ 'global-0' => 0 ] ],
+            [ new \ArrayIterator([ 1, 2 ]), '-', 'global', [ 'global-0' => 1, 'global-1' => 2 ] ],
+            [
+                new \ArrayIterator([ 1, 2, [ 3, 4 ] ]),
+                '-',
+                'global',
+                [ 'global-0' => 1, 'global-1' => 2, 'global-2-0' => 3, 'global-2-1' => 4 ]
+            ],
+            [
+                new \ArrayIterator([ 'a' => 1, 2, 'b' => new \ArrayIterator([ 3, 'c' => 4 ]) ]),
+                '/',
+                'local',
+                [ 'local/a' => 1, 'local/0' => 2, 'local/b/0' => 3, 'local/b/c' => 4 ]
+            ],
+            [
+                new \ArrayIterator([ 'a' => 1, 'b' => 2, 'c' => [ 'd' => [ 3, 4 ], 'e' => new \ArrayIterator([ 'f' => 5, 'g' => 6 ]) ] ]),
+                '',
+                ':',
+                [ ':a' => 1, ':b' => 2, ':cd0' => 3, ':cd1' => 4, ':cef' => 5, ':ceg' => 6 ]
+            ]
+        ];
+    }
+    
+    /**
+     * @covers Flatten::flatten
+     * @dataProvider traversablesSeparatorPrefixProvider
+     */
+    public function testFlattenTraversableWithSeparatorAndPrefix($var, $separator, $prefix, $expectedOutput)
+    {
+        $output = Flatten::flatten($var, $separator, $prefix);
+        $this->assertEquals($expectedOutput, $output);
+    }
+}