Class Guzzle\Service\Resource\Model

InheritanceGuzzle\Service\Resource\Model » Guzzle\Common\Collection
ImplementsArrayAccess, Countable, Guzzle\Common\ToArrayInterface, IteratorAggregate

Default model created when commands create service description model responses

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$data array Data associated with the object. Guzzle\Common\Collection
$structure Guzzle\Service\Description\Parameter Structure of the model Guzzle\Service\Resource\Model

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Guzzle\Service\Resource\Model
__toString() Provides debug information about the model object Guzzle\Service\Resource\Model
add() 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. Guzzle\Common\Collection
clear() Removes all key value pairs Guzzle\Common\Collection
count() Guzzle\Common\Collection
filter() 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. Guzzle\Common\Collection
fromConfig() Create a new collection from an array, validate the keys, and add default values where missing Guzzle\Common\Collection
get() Get a specific key value. Guzzle\Common\Collection
getAll() Get all or a subset of matching key value pairs Guzzle\Common\Collection
getIterator() Guzzle\Common\Collection
getKeys() Get all keys in the collection Guzzle\Common\Collection
getPath() 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. Guzzle\Common\Collection
getStructure() Get the structure of the model Guzzle\Service\Resource\Model
hasKey() Returns whether or not the specified key is present. Guzzle\Common\Collection
hasValue() Checks if any keys contains a certain value Guzzle\Common\Collection
inject() Inject configuration settings into an input string Guzzle\Common\Collection
keySearch() Case insensitive search the keys in the collection Guzzle\Common\Collection
map() 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 Guzzle\Common\Collection
merge() Add and merge in a Collection or array of key value pair data. Guzzle\Common\Collection
offsetExists() Guzzle\Common\Collection
offsetGet() Guzzle\Common\Collection
offsetSet() Guzzle\Common\Collection
offsetUnset() Guzzle\Common\Collection
overwriteWith() Over write key value pairs in this collection with all of the data from an array or collection. Guzzle\Common\Collection
remove() Remove a specific key value pair Guzzle\Common\Collection
replace() Replace the data of the object with the value of an array Guzzle\Common\Collection
set() Set a key value pair Guzzle\Common\Collection
setPath() Set a value into a nested array key. Keys will be created as needed to set the value. Guzzle\Common\Collection
toArray() Guzzle\Common\Collection

Property Details

$structure protected property

Structure of the model

Method Details

__construct() public method

public void __construct ( array $data = [], Guzzle\Service\Description\Parameter $structure null )
$data array

Data contained by the model

$structure Guzzle\Service\Description\Parameter

The structure of the model

__toString() public method

Provides debug information about the model object

public string __toString ( )
getStructure() public method

Get the structure of the model

public Guzzle\Service\Description\Parameter getStructure ( )