update doc blocks

Author: AlaaSarhan

src/Flatten.php

@@ -3,8 +3,7 @@
 namespace Sarhan\Flatten;
 
 /**
- * @author Alaa Sarhan <sarhan.alaa@gmail.com>
- * @license LGPL
+ * Flattens values, possibly traversables, into a one-dimensional array, recursively.
  */
 class Flatten
 {
@@ -50,13 +49,13 @@ public function __construct(
     }
 
     /**
-     * Flattens a variable, possibly traversable, into a one-dimensional array, recursively.
-     *
+     * Flattens a traversable or array into a 1-dimensional array.
+     * 
      * Each key (fully-qualified key or FQK) in the returned one-dimensional array is the join of all keys leading to
-     * each (non-traversable) value, in all dimensions, separated by a given separator.
-     *
-     * An initial prefix can be optionally provided, but it will not be separated with the specified separator.
+     * each (non-traversable) value, in all dimensions, separated by the configured separator.
      *
+     * The configured prefix will be appended to all FQKs, but it will not be separated with the configured separator.
+     * 
      * @param mixed $var
      * @return array 1-dimensional array containing all values from all possible traversable dimensions in given input.
      */

test/FlattenTest.php

@@ -23,9 +23,9 @@ public function scalarProvider()
      * @covers Flatten::flatten
      * @dataProvider scalarProvider
      */
-    public function testFlattenScalar($var, $expectedOutput)
+    public function testFlattenScalar($input, $expectedOutput)
     {
-        $output = $this->flattenToArray($var);
+        $output = $this->flattenToArray($input);
 
         $this->assertEquals($expectedOutput, $output);
     }
@@ -46,9 +46,9 @@ public function scalarSeparatorPrefixProvider()
      * @covers Flatten::flatten
      * @dataProvider scalarSeparatorPrefixProvider
      */
-    public function testFlattenScalarWithSeparatorAndPrefix($var, $separator, $prefix, $expectedOutput)
+    public function testFlattenScalarWithSeparatorAndPrefix($input, $separator, $prefix, $expectedOutput)
     {
-        $output = $this->flattenToArray($var, $separator, $prefix);
+        $output = $this->flattenToArray($input, $separator, $prefix);
 
         $this->assertEquals($expectedOutput, $output);
     }
@@ -78,9 +78,9 @@ public function arraysProvider()
      * @covers Flatten::flatten
      * @dataProvider arraysProvider
      */
-    public function testFlattenArrays($var, $expectedOutput)
+    public function testFlattenArrays($input, $expectedOutput)
     {
-        $output = $this->flattenToArray($var);
+        $output = $this->flattenToArray($input);
 
         $this->assertEquals($expectedOutput, $output);
     }
@@ -114,9 +114,9 @@ public function traversablesProvider()
      * @covers Flatten::flatten
      * @dataProvider traversablesProvider
      */
-    public function testFlattenTraversable($var, $expectedOutput)
+    public function testFlattenTraversable($input, $expectedOutput)
     {
-        $output = $this->flattenToArray($var);
+        $output = $this->flattenToArray($input);
         $this->assertEquals($expectedOutput, $output);
     }
 
@@ -155,9 +155,9 @@ public function traversablesSeparatorPrefixProvider()
      * @covers Flatten::flatten
      * @dataProvider traversablesSeparatorPrefixProvider
      */
-    public function testFlattenTraversableWithSeparatorAndPrefix($var, $separator, $prefix, $expectedOutput)
+    public function testFlattenTraversableWithSeparatorAndPrefix($input, $separator, $prefix, $expectedOutput)
     {
-        $output = $this->flattenToArray($var, $separator, $prefix);
+        $output = $this->flattenToArray($input, $separator, $prefix);
         $this->assertEquals($expectedOutput, $output);
     }
 
@@ -214,18 +214,18 @@ public function flattenWithFlagsProvidor()
      * @covers Flatten::flatten
      * @dataProvider flattenWithFlagsProvidor
      */
-    public function testFlattenWithFlags($var, $separator, $prefix, $flags, $expectedOutput)
+    public function testFlattenWithFlags($input, $separator, $prefix, $flags, $expectedOutput)
     {
-        $output = $this->flattenToArray($var, $separator, $prefix, $flags);
+        $output = $this->flattenToArray($input, $separator, $prefix, $flags);
         $this->assertEquals($expectedOutput, $output);
     }
 
     private function flattenToArray(
-        $var,
+        $input,
         $separator = Flatten::DEFAULT_SEPARATOR,
         $prefix = Flatten::DEFAULT_PREFIX,
         $flags = Flatten::DEFAULT_FLAGS
     ) {
-        return iterator_to_array((new Flatten($separator, $prefix, $flags))->flatten($var));
+        return iterator_to_array((new Flatten($separator, $prefix, $flags))->flatten($input));
     }
 }