mirror_php/guzzle
1
0
Fork 0
mirror of https://github.com/guzzle/guzzle.git synced 2025-02-25 02:22:57 +01:00
Code Issues Releases Wiki Activity

Moving setPath to PathTrait

Browse Source
This commit is contained in:
Michael Dowling 2014-02-27 22:07:14 -08:00
parent f4ccb75e8e
commit 7f0434236b
3 changed files with 89 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
src/Collection.php
View File

@ -7,7 +7,7 @@ namespace GuzzleHttp;
*/
class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, ToArrayInterface
{
use GetPathTrait;
use PathTrait;
/**
* @param array $data Associative array of data to set
@ -257,50 +257,4 @@ class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, ToArra
return $collection;
}
/**
* 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
*
* @return self
* @throws \RuntimeException when trying to setPath using a nested path
* that travels through a scalar value
*/
public function setPath($path, $value)
{
$current =& $this->data;
$queue = explode('/', $path);
while (null !== ($key = array_shift($queue))) {
if (!is_array($current)) {
throw new \RuntimeException("Trying to setPath {$path}, but {$key} is set and is not an array");
} elseif (!$queue) {
if ($key == '[]') {
$current[] = $value;
} else {
$current[$key] = $value;
}
} elseif (isset($current[$key])) {
$current =& $current[$key];
} else {
$current[$key] = [];
$current =& $current[$key];
}
}
return $this;
}
}

42
src/GetPathTrait.php
View File

@ -1,42 +0,0 @@
<?php
namespace GuzzleHttp;
/**
* Trait implementing getPath on top of HasDataTrait
*/
trait GetPathTrait
{
use HasDataTrait;
/**
* 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
*
* @return mixed|null
*/
public function getPath($path)
{
$data =& $this->data;
$path = explode('/', $path);
while (null !== ($part = array_shift($path))) {
if (!is_array($data) || !isset($data[$part])) {
return null;
}
$data =& $data[$part];
}
return $data;
}
}

88
src/PathTrait.php Normal file
View File

@ -0,0 +1,88 @@
<?php
namespace GuzzleHttp;
/**
* Trait implementing getPath and setPath on top of HasDataTrait
*/
trait PathTrait
{
use HasDataTrait;
/**
* 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
*
* @return mixed|null
*/
public function getPath($path)
{
$data =& $this->data;
$path = explode('/', $path);
while (null !== ($part = array_shift($path))) {
if (!is_array($data) || !isset($data[$part])) {
return null;
}
$data =& $data[$part];
}
return $data;
}
/**
* 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
*
* @return self
* @throws \RuntimeException when trying to setPath using a nested path
* that travels through a scalar value
*/
public function setPath($path, $value)
{
$current =& $this->data;
$queue = explode('/', $path);
while (null !== ($key = array_shift($queue))) {
if (!is_array($current)) {
throw new \RuntimeException("Trying to setPath {$path}, but {$key} is set and is not an array");
} elseif (!$queue) {
if ($key == '[]') {
$current[] = $value;
} else {
$current[$key] = $value;
}
} elseif (isset($current[$key])) {
$current =& $current[$key];
} else {
$current[$key] = [];
$current =& $current[$key];
}
}
return $this;
}
}