Merge pull request #197 from tonydspaniard/196-add-popvalue-method

Enhance ArrayHelper with popValue method

tests/unit/framework/helpers/ArrayHelperTest.php

@@ -12,6 +12,16 @@ class ArrayHelperTest extends \yii\test\TestCase
 
 	}
 
+	public function testRemove()
+	{
+		$array = array('name' => 'b', 'age' => 3);
+		$name = ArrayHelper::remove($array, 'name');
+
+		$this->assertEquals($name, 'b');
+		$this->assertEquals($array, array('age' => 3));
+	}
+
+
 	public function testMultisort()
 	{
 		// single key

yii/helpers/base/ArrayHelper.php

@@ -87,6 +87,35 @@ class ArrayHelper
 	}
 
 	/**
+	 * Removes an item from an array and returns the value. If the key does not exist in the array, the default value
+	 * will be returned instead.
+	 *
+	 * Usage examples,
+	 *
+	 * ~~~
+	 * // $array = array('type'=>'A', 'options'=>array(1,2));
+	 * // working with array
+	 * $type = \yii\helpers\ArrayHelper::remove($array, 'type');
+	 * // $array content
+	 * // $array = array('options'=>array(1,2));
+	 * ~~~
+	 *
+	 * @param array $array the array to extract value from
+	 * @param string $key key name of the array element
+	 * @param mixed $default the default value to be returned if the specified key does not exist
+	 * @return mixed|null the value of the element if found, default value otherwise
+	 */
+	public static function remove(&$array, $key, $default = null)
+	{
+		if (is_array($array) && (isset($array[$key]) || array_key_exists($key, $array))) {
+			$value = $array[$key];
+			unset($array[$key]);
+			return $value;
+		}
+		return $default;
+	}
+
+	/**
 	 * Indexes an array according to a specified key.
 	 * The input array should be multidimensional or an array of objects.
 	 *