Class Collection
Key value pair collection object
- Guzzle\Common\Collection implements ArrayAccess, IteratorAggregate, Countable, Guzzle\Common\ToArrayInterface
Direct known subclasses
Aws\Common\Waiter\WaiterConfig,
Aws\S3\Model\PostObject,
Guzzle\Http\QueryString,
Guzzle\Service\Command\AbstractCommand,
Guzzle\Service\Resource\Model
Indirect known subclasses
Aws\Common\Command\JsonCommand,
Aws\Common\Command\QueryCommand,
Aws\S3\Command\S3Command,
Guzzle\Service\Command\ClosureCommand,
Guzzle\Service\Command\OperationCommand
Methods summary
-
public__construct ( array $data = array() ) -
public staticfromConfig ( array $config = array(), array $defaults = array(), array $required = array() )Create a new collection from an array, validate the keys, and add default values where missing
-
publiccount ( ) -
publicgetIterator ( ) -
publictoArray ( )Get the array representation of an object
-
publicclear ( )Removes all key value pairs
-
publicgetAll ( array $keys = null )Get all or a subset of matching key value pairs
-
publicget ( string $key )Get a specific key value.
-
publicset ( string $key, mixed $value )Set a key value pair
-
publicadd ( string $key, mixed $value )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.
-
publicremove ( string $key )Remove a specific key value pair
-
publicgetKeys ( )Get all keys in the collection
-
publichasKey ( string $key )Returns whether or not the specified key is present.
-
publickeySearch ( string $key )Case insensitive search the keys in the collection
-
publichasValue ( string $value )Checks if any keys contains a certain value
-
publicreplace ( array $data )Replace the data of the object with the value of an array
-
publicmerge ( Collection|array $data )Add and merge in a Collection or array of key value pair data.
-
publicoverwriteWith ( array|\Traversable $data )Over write key value pairs in this collection with all of the data from an array or collection.
-
publicmap ( Closure $closure, array $context = array(), bool $static = true )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
-
publicfilter ( Closure $closure, bool $static = true )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.
-
publicoffsetExists ( mixed $offset ) -
publicoffsetGet ( mixed $offset ) -
publicoffsetSet ( mixed $offset, mixed $value ) -
publicoffsetUnset ( mixed $offset ) -
publicsetPath ( string $path, mixed $value )Set a value into a nested array key. Keys will be created as needed to set the value.
-
publicgetPath ( string $path, string $separator = '/', mixed $data = 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.
Methods detail
Parameters
- $data
array
$data Associative array of data to set
public static
Guzzle\Common\Collection
fromConfig( array $config = array(), array $defaults = array(), array $required = array() )
Create a new collection from an array, validate the keys, and add default values where missing
Parameters
- $config
array
$config Configuration values to apply.- $defaults
array
$defaults Default parameters- $required
array
$required Required parameter names
Returns
Throws
Implementation of
Implementation of
Get the array representation of an object
Returns
arrayImplementation of
Get all or a subset of matching key value pairs
Parameters
- $keys
array
$keys Pass an array of keys to retrieve only a subset of key value pairs
Returns
arrayReturns an array of all matching key value pairs
Get a specific key value.
Parameters
- $key
string
$key Key to retrieve.
Returns
mixed|nullValue of the key or NULL
Set a key value pair
Parameters
- $key
string
$key Key to set- $value
mixed
$value Value to set
Returns
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.
Parameters
- $key
string
$key Key to add- $value
mixed
$value Value to add to the key
Returns
Remove a specific key value pair
Parameters
- $key
string
$key A key to remove
Returns
Get all keys in the collection
Returns
arrayReturns whether or not the specified key is present.
Parameters
- $key
string
$key The key for which to check the existence.
Returns
booleanCase insensitive search the keys in the collection
Parameters
- $key
string
$key Key to search for
Returns
boolean|stringReturns false if not found, otherwise returns the key
Checks if any keys contains a certain value
Parameters
- $value
string
$value Value to search for
Returns
mixedReturns the key if the value was found FALSE if the value was not found.
Replace the data of the object with the value of an array
Parameters
- $data
array
$data Associative array of data
Returns
Add and merge in a Collection or array of key value pair data.
Parameters
- $data
Guzzle\Common\Collection|array
$data Associative array of key value pair data
Returns
Over write key value pairs in this collection with all of the data from an array or collection.
Parameters
- $data
array|Traversable
$data Values to override over this config
Returns
public
Guzzle\Common\Collection
map( Closure $closure, array $context = array(), boolean $static = true )
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
Parameters
- $closure
Closure
$closure Closure to apply- $context
array
$context Context to pass to the closure- $static
boolean
$static Set to TRUE to use the same class as the return rather than returning a Collection
Returns
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.
Parameters
- $closure
Closure
$closure Closure evaluation function- $static
boolean
$static Set to TRUE to use the same class as the return rather than returning a Collection
Returns
Implementation of
Implementation of
Implementation of
Implementation of
Set a value into a nested array key. Keys will be created as needed to set the value.
Parameters
- $path
string
$path Path to set- $value
mixed
$value Value to set at the key
Returns
Throws
Guzzle\Common\Exception\RuntimeExceptionwhen trying to setPath using a nested path that travels through a scalar value
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.
Parameters
- $path
string
$path Path to traverse and retrieve a value from- $separator
string
$separator Character used to add depth to the search- $data
mixed
$data Optional data to descend into (used when wildcards are encountered)
Returns
mixed|nullMagic methods summary
Properties summary
protected
array
|
$data |
#
Data associated with the object. |