$data
$data : array
Key value pair collection object
fromConfig(array $config = array(), array $defaults = array(), array $required = array()) : self
Create a new collection from an array, validate the keys, and add default values where missing
| array | $config | Configuration values to apply. |
| array | $defaults | Default parameters |
| array | $required | Required parameter names |
if a parameter is missing
clear() : \Guzzle\Common\Collection
Removes all key value pairs
set(string $key, mixed $value) : \Guzzle\Common\Collection
Set a key value pair
| string | $key | Key to set |
| mixed | $value | Value to set |
Returns a reference to the object
add(string $key, mixed $value) : \Guzzle\Common\Collection
Add a value to a key. If a key of the same name has already been added, the key value will be converted into an array and the new value will be pushed to the end of the array.
| string | $key | Key to add |
| mixed | $value | Value to add to the key |
Returns a reference to the object.
remove(string $key) : \Guzzle\Common\Collection
Remove a specific key value pair
| string | $key | A key to remove |
replace(array $data) : \Guzzle\Common\Collection
Replace the data of the object with the value of an array
| array | $data | Associative array of data |
Returns a reference to the object
merge(\Guzzle\Common\Collection|array $data) : \Guzzle\Common\Collection
Add and merge in a Collection or array of key value pair data.
| \Guzzle\Common\Collection|array | $data | Associative array of key value pair data |
Returns a reference to the object.
map(\Closure $closure, array $context = array(), boolean $static = true) : \Guzzle\Common\Collection
Returns a Collection containing all the elements of the collection after applying the callback function to each one. The Closure should accept three parameters: (string) $key, (string) $value, (array) $context and return a modified value
| \Closure | $closure | Closure to apply |
| array | $context | Context to pass to the closure |
| boolean | $static | Set to TRUE to use the same class as the return rather than returning a Collection |
filter(\Closure $closure, boolean $static = true) : \Guzzle\Common\Collection
Iterates over each key value pair in the collection passing them to the Closure. If the Closure function returns true, the current value from input is returned into the result Collection. The Closure must accept three parameters: (string) $key, (string) $value and return Boolean TRUE or FALSE for each value.
| \Closure | $closure | Closure evaluation function |
| boolean | $static | Set to TRUE to use the same class as the return rather than returning a Collection |
setPath(string $path, mixed $value) : self
Set a value into a nested array key. Keys will be created as needed to set the value.
| string | $path | Path to set |
| mixed | $value | Value to set at the key |
when trying to setPath using a nested path that travels through a scalar value
getPath(string $path, string $separator = '/', mixed $data = null) : mixed|null
Gets a value from the collection using an array path (e.g. foo/baz/bar would retrieve bar from two nested arrays) Allows for wildcard searches which recursively combine matches up to the level at which the wildcard occurs. This can be useful for accepting any key of a sub-array and combining matching keys from each diverging path.
| string | $path | Path to traverse and retrieve a value from |
| string | $separator | Character used to add depth to the search |
| mixed | $data | Optional data to descend into (used when wildcards are encountered) |