mirror_php/guzzle
1
0
Fork 0
mirror of https://github.com/guzzle/guzzle.git synced 2025-02-24 10:03:27 +01:00
Code Issues Releases Wiki Activity

Adding the ability to append an array value using setPath

Browse Source
This commit is contained in:
Michael Dowling 2014-02-07 15:33:30 -08:00
parent 0014d3962a
commit 734b94f8a7
2 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/Guzzle/Common/Collection.php
View File

@ -253,6 +253,16 @@ class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, ToArra
/**
* Set a value into a nested array key. Keys will be created as needed to set the value.
*
* This function does not support keys that contain "/" or "[]" characters because these are special tokens used
* when traversing the data structure. A value may be prepended to an existing array by using "[]" as the final
* key of a path.
*
* $collection->getPath('foo/baz'); // null
* $collection->setPath('foo/baz/[]', 'a');
* $collection->setPath('foo/baz/[]', 'b');
* $collection->getPath('foo/baz');
* // Returns ['a', 'b']
*
* @param string $path Path to set
* @param mixed $value Value to set at the key
*
@ -267,7 +277,11 @@ class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, ToArra
if (!is_array($current)) {
throw new \RuntimeException("Trying to setPath {$path}, but {$key} is set and is not an array");
} elseif (!$queue) {
$current[$key] = $value;
if ($key == '[]') {
$current[] = $value;
} else {
$current[$key] = $value;
}
} elseif (isset($current[$key])) {
$current =& $current[$key];
} else {
@ -280,8 +294,15 @@ class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, ToArra
}
/**
* Gets a value from the collection using an array path
* (e.g. foo/baz/bar would retrieve bar from two nested arrays)
* Gets a value from the collection using an array path.
*
* This method does not allow for keys that contain "/". You must traverse the array manually or using something
* more advanced like JMESPath to work with keys that contain "/".
*
* // Get the bar key of a set of nested arrays.
* // This is equivalent to $collection['foo']['baz']['bar'] but won't
* // throw warnings for missing keys.
* $collection->getPath('foo/baz/bar');
*
* @param string $path Path to traverse and retrieve a value from
*

8
tests/Guzzle/Tests/Common/CollectionTest.php
View File

@ -412,4 +412,12 @@ class CollectionTest extends \PHPUnit_Framework_TestCase
$c = new Collection(array('foo' => 'bar'));
$c->setPath('foo/bar/baz', 'test');
}
public function testCanAppendToNestedPathValues()
{
$c = new Collection();
$c->setPath('foo/bar/[]', 'a');
$c->setPath('foo/bar/[]', 'b');
$this->assertEquals(['a', 'b'], $c['foo']['bar']);
}
}