Merge branch 'feature/zendframework/zendframework#6899-arrayutils-mer…

…ge-ability-to-remove-keys' into develop Close zendframework/zendframework#6899
zendframework · Dec 6, 2014 · 1756cda · 1756cda
2 parents 1cf8662 + 157add3
commit 1756cda
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 4 deletions.
diff --git a/src/ArrayUtils.php b/src/ArrayUtils.php
@@ -10,6 +10,7 @@
 namespace Zend\Stdlib;
 
 use Traversable;
+use Zend\Stdlib\ArrayUtils\MergeRemoveKey;
 
 /**
  * Utility class for testing and manipulation of PHP arrays.
@@ -258,15 +259,19 @@ public static function merge(array $a, array $b, $preserveNumericKeys = false)
     {
         foreach ($b as $key => $value) {
             if (isset($a[$key]) || array_key_exists($key, $a)) {
-                if (!$preserveNumericKeys && is_int($key)) {
+                if ($value instanceof MergeRemoveKey) {
+                    unset($a[$key]);
+                } elseif (!$preserveNumericKeys && is_int($key)) {
                     $a[] = $value;
                 } elseif (is_array($value) && is_array($a[$key])) {
                     $a[$key] = static::merge($a[$key], $value, $preserveNumericKeys);
                 } else {
                     $a[$key] = $value;
                 }
             } else {
-                $a[$key] = $value;
+                if (!$value instanceof MergeRemoveKey) {
+                    $a[$key] = $value;
+                }
             }
         }
 

diff --git a/src/ArrayUtils/MergeRemoveKey.php b/src/ArrayUtils/MergeRemoveKey.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Stdlib\ArrayUtils;
+
+final class MergeRemoveKey
+{
+}
diff --git a/test/ArrayUtilsTest.php b/test/ArrayUtilsTest.php
@@ -9,11 +9,12 @@
 
 namespace ZendTest\Stdlib;
 
+use ArrayObject;
 use PHPUnit_Framework_TestCase as TestCase;
 use stdClass;
-use ArrayObject;
-use Zend\Stdlib\ArrayUtils;
 use Zend\Config\Config;
+use Zend\Stdlib\ArrayUtils;
+use Zend\Stdlib\ArrayUtils\MergeRemoveKey;
 
 class ArrayUtilsTest extends TestCase
 {
@@ -263,6 +264,25 @@ public static function mergeArrays()
         );
     }
 
+    /**
+     * @group 6899
+     */
+    public function testAllowsRemovingKeys()
+    {
+        $a = array(
+            'foo' => 'bar',
+            'bar' => 'bat'
+        );
+        $b = array(
+            'foo' => new MergeRemoveKey(),
+            'baz' => new MergeRemoveKey(),
+        );
+        $expected = array(
+            'bar' => 'bat'
+        );
+        $this->assertEquals($expected, ArrayUtils::merge($a, $b));
+    }
+
     public static function validIterators()
     {
         return array(