Merge pull request bocharsky-bw#11 from bocharsky-bw/multiple-args

Add ability to push/unshift multiple values at once - thanks @pomaxa

Author: bocharsky-bw

README.md

@@ -611,11 +611,13 @@ $a->previous(); // 'b'
 ### push
 
 ``` php
-$a = MutableArray::create(['a', 'b', 'c']);
-$a->push('d');
+$a = MutableArray::create(['a', 'b']);
+$a->push('c', 'd');
 $a->toArray(); // [0 => 'a', 1 => 'b', 2 => 'c', 3 => 'd']
 ```
 
+> Method `push()` allow multiple arguments.
+
 ### reduce
 
 ``` php
@@ -744,11 +746,13 @@ $a->toArray(); // [0 => 'a', 1 => 'b', 3 => 'c']
 ### unshift
 
 ``` php
-$a = MutableArray::create(['b', 'c']);
-$a->unshift('a');
-$a->toArray(); // [0 => 'a', 1 => 'b', 2 => 'c']
+$a = MutableArray::create([('a', 'b']);
+$a->unshift('y', 'z');
+$a->toArray(); // [0 => 'y', 1 => 'z', 2 => 'a', 3 => 'b']
 ```
 
+> Method `unshift()` allow multiple arguments.
+
 ### walk
 
 ``` php

src/Interfaces/ModifiableInterface.php

@@ -17,13 +17,14 @@ interface ModifiableInterface
     public function shift();
 
     /**
-     * Prepends a new value to the beginning of array.
+     * Prepends one or more values to the beginning of array at once.
      *
      * @param mixed $element The element for prepend
+     * @param mixed $_ [optional] Multiple arguments allowed
      *
-     * @return $this The same instance with prepended element to the beginning of array
+     * @return $this The same instance with prepended elements to the beginning of array
      */
-    public function unshift($element);
+    public function unshift($element, $_ = null);
 
     /**
      * Pop a specified value off the end of array.
@@ -33,11 +34,12 @@ public function unshift($element);
     public function pop();
 
     /**
-     * Push value onto the end of array.
+     * Push one or more values onto the end of array at once.
      *
      * @param mixed $element The pushed element
+     * @param mixed $_ [optional] Multiple arguments allowed
      *
-     * @return $this The same instance with pushed element to the end of array
+     * @return $this The same instance with pushed elements to the end of array
      */
-    public function push($element);
+    public function push($element, $_ = null);
 }

src/Traits/ModifiableTrait.php

@@ -24,17 +24,21 @@ public function shift()
     }
 
     /**
-     * Prepends a new value to the beginning of array.
+     * Prepends one or more values to the beginning of array at once.
      *
      * @param mixed $element The element for prepend
+     * @param mixed $_ [optional] Multiple arguments allowed
      *
-     * @return $this The same instance with prepended element to the beginning of array
+     * @return $this The same instance with prepended elements to the beginning of array
      *
      * @link http://php.net/manual/en/function.array-unshift.php
      */
-    public function unshift($element)
+    public function unshift($element, $_ = null)
     {
-        array_unshift($this->elements, $element);
+        if (func_num_args()) {
+            $args = array_merge([&$this->elements], func_get_args());
+            call_user_func_array('array_unshift', $args);
+        }
 
         return $this;
     }
@@ -52,17 +56,21 @@ public function pop()
     }
 
     /**
-     * Push value onto the end of array.
+     * Push one or more values onto the end of array at once.
      *
      * @param mixed $element The pushed element
+     * @param mixed $_ [optional] Multiple arguments allowed
      *
-     * @return $this The same instance with pushed element to the end of array
+     * @return $this The same instance with pushed elements to the end of array
      *
      * @link http://php.net/manual/en/function.array-push.php
      */
-    public function push($element)
+    public function push($element, $_ = null)
     {
-        array_push($this->elements, $element);
+        if (func_num_args()) {
+            $args = array_merge([&$this->elements], func_get_args());
+            call_user_func_array('array_push', $args);
+        }
 
         return $this;
     }

tests/ImmutableArrayTest.php

@@ -569,10 +569,11 @@ public function testShift(array $array)
      */
     public function testUnshift(array $array)
     {
-        $newElement = 5;
+        $newElement1 = 5;
+        $newElement2 = 10;
         $ma = new ImmutableArray($array);
-        $copiedMa = $ma->unshift($newElement);
-        array_unshift($array, $newElement);
+        $copiedMa = $ma->unshift($newElement1, $newElement2);
+        array_unshift($array, $newElement1, $newElement2);
 
         $this->assertTrue($copiedMa === $ma);
         $this->assertTrue($array === $copiedMa->toArray());
@@ -596,10 +597,11 @@ public function testPop(array $array)
      */
     public function testPush(array $array)
     {
-        $newElement = 5;
+        $newElement1 = 5;
+        $newElement2 = 10;
         $ma = new ImmutableArray($array);
-        $copiedMa = $ma->push($newElement);
-        array_push($array, $newElement);
+        $copiedMa = $ma->push($newElement1, $newElement2);
+        array_push($array, $newElement1, $newElement2);
 
         $this->assertTrue($copiedMa === $ma);
         $this->assertTrue($array === $copiedMa->toArray());