\Guzzle\Service\DescriptionParameter

__construct()

__construct(array  $data = array(), \Guzzle\Service\Description\ServiceDescriptionInterface  $description = null) 

Create a new Parameter using an associative array of data. The array can contain the following information: - name: (string) Unique name of the parameter - type: (string|array) Type of variable (string, number, integer, boolean, object, array, numeric, null, any). Types are using for validation and determining the structure of a parameter. You can use a union type by providing an array of simple types. If one of the union types matches the provided value, then the value is valid.

• instanceOf: (string) When the type is an object, you can specify the class that the object must implement
• required: (bool) Whether or not the parameter is required
• default: (mixed) Default value to use if no value is supplied
• static: (bool) Set to true to specify that the parameter value cannot be changed from the default
• description: (string) Documentation of the parameter
• location: (string) The location of a request used to apply a parameter. Custom locations can be registered with a command, but the defaults are uri, query, header, body, json, xml, postField, postFile.
• sentAs: (string) Specifies how the data being modeled is sent over the wire. For example, you may wish to include certain headers in a response model that have a normalized casing of FooBar, but the actual header is x-foo-bar. In this case, sentAs would be set to x-foo-bar.
• filters: (array) Array of static method names to to run a parameter value through. Each value in the array must be a string containing the full class path to a static method or an array of complex filter information. You can specify static methods of classes using the full namespace class name followed by '::' (e.g. Foo\Bar::baz()). Some filters require arguments in order to properly filter a value. For complex filters, use a hash containing a 'method' key pointing to a static method, and an 'args' key containing an array of positional arguments to pass to the method. Arguments can contain keywords that are replaced when filtering a value: '@value' is replaced with the value being validated, '@api' is replaced with the Parameter object.
• properties: When the type is an object, you can specify nested parameters
• additionalProperties: (array) This attribute defines a schema for all properties that are not explicitly defined in an object type definition. If specified, the value MUST be a schema or a boolean. If false is provided, no additional properties are allowed beyond the properties defined in the schema. The default value is an empty schema which allows any value for additional properties.
• items: This attribute defines the allowed items in an instance array, and MUST be a schema or an array of schemas. The default value is an empty schema which allows any value for items in the instance array. When this attribute value is a schema and the instance value is an array, then all the items in the array MUST be valid according to the schema.
• pattern: When the type is a string, you can specify the regex pattern that a value must match
• enum: When the type is a string, you can specify a list of acceptable values
• minItems: (int) Minimum number of items allowed in an array
• maxItems: (int) Maximum number of items allowed in an array
• minLength: (int) Minimum length of a string
• maxLength: (int) Maximum length of a string
• minimum: (int) Minimum value of an integer
• maximum: (int) Maximum value of an integer
• data: (array) Any additional custom data to use when serializing, validating, etc
• format: (string) Format used to coax a value into the correct format when serializing or unserializing. You may specify either an array of filters OR a format, but not both. Supported values: date-time, date, time, timestamp, date-time-http
• $ref: (string) String referencing a service description model. The parameter is replaced by the schema contained in the model.

Parameters

Throws

\Guzzle\Common\Exception\InvalidArgumentException

toArray()

toArray() : array

Convert the object to an array

Returns

getValue()

getValue(string  $value) : mixed

Get the default or static value of the command based on a value

Parameters

Returns

Returns the value, a static value if one is present, or a default value

filter()

filter(mixed  $value) : mixed

Run a value through the filters OR format attribute associated with the parameter

Parameters

Returns

Returns the filtered value

getName()

getName() : string

Get the name of the parameter

Returns

getWireName()

getWireName() : string

Get the key of the parameter, where sentAs will supersede name if it is set

Returns

setName()

setName(string  $name) : self

Set the name of the parameter

Parameters

Returns

getType()

getType() : string|array

Get the type(s) of the parameter

Returns

setType()

setType(string|array  $type) : self

Set the type(s) of the parameter

Parameters

Returns

getRequired()

getRequired() : boolean

Get if the parameter is required

Returns

setRequired()

setRequired(boolean  $isRequired) : self

Set if the parameter is required

Parameters

Returns

getDefault()

getDefault() : string|null

Get the default value of the parameter

Returns

setDefault()

setDefault(string|null  $default) : self

Set the default value of the parameter

Parameters

Returns

getDescription()

getDescription() : string|null

Get the description of the parameter

Returns

setDescription()

setDescription(string  $description) : self

Set the description of the parameter

Parameters

Returns

getMinimum()

getMinimum() : integer|null

Get the minimum acceptable value for an integer

Returns

setMinimum()

setMinimum(integer|null  $min) : self

Set the minimum acceptable value for an integer

Parameters

Returns

getMaximum()

getMaximum() : integer|null

Get the maximum acceptable value for an integer

Returns

setMaximum()

setMaximum(integer  $max) : self

Set the maximum acceptable value for an integer

Parameters

Returns

getMinLength()

getMinLength() : integer

Get the minimum allowed length of a string value

Returns

setMinLength()

setMinLength(integer|null  $min) : self

Set the minimum allowed length of a string value

Parameters

Returns

getMaxLength()

getMaxLength() : integer|null

Get the maximum allowed length of a string value

Returns

setMaxLength()

setMaxLength(integer  $max) : self

Set the maximum allowed length of a string value

Parameters

Returns

getMaxItems()

getMaxItems() : integer|null

Get the maximum allowed number of items in an array value

Returns

setMaxItems()

setMaxItems(integer  $max) : self

Set the maximum allowed number of items in an array value

Parameters

Returns

getMinItems()

getMinItems() : integer

Get the minimum allowed number of items in an array value

Returns

setMinItems()

setMinItems(integer|null  $min) : self

Set the minimum allowed number of items in an array value

Parameters

Returns

getLocation()

getLocation() : string|null

Get the location of the parameter

Returns

setLocation()

setLocation(string|null  $location) : self

Set the location of the parameter

Parameters

Returns

getSentAs()

getSentAs() : string|null

Get the sentAs attribute of the parameter that used with locations to sentAs an attribute when it is being applied to a location.

Returns

setSentAs()

setSentAs(string|null  $name) : self

Set the sentAs attribute

Parameters

Returns

getData()

getData(string|null  $name = null) : array|mixed|null

Retrieve a known property from the parameter by name or a data property by name. When not specific name value is specified, all data properties will be returned.

Parameters

Returns

setData()

setData(string|array|null  $nameOrData, mixed|null  $data = null) : self

Set the extra data properties of the parameter or set a specific extra property

Parameters

Returns

getStatic()

getStatic() : mixed|null

Get whether or not the default value can be changed

Returns

setStatic()

setStatic(boolean  $static) : self

Set to true if the default value cannot be changed

Parameters

Returns

getFilters()

getFilters() : array

Get an array of filters used by the parameter

Returns

setFilters()

setFilters(array  $filters) : self

Set the array of filters used by the parameter

Parameters

Returns

addFilter()

addFilter(string|array  $filter) : self

Add a filter to the parameter

Parameters

Throws

\Guzzle\Common\Exception\InvalidArgumentException

Returns

getParent()

getParent() : \Guzzle\Service\Description\OperationInterface|\Guzzle\Service\Description\Parameter|null

Get the parent object (an {@see OperationInterface} or {@see Parameter}

Returns

setParent()

setParent(\Guzzle\Service\Description\OperationInterface|\Guzzle\Service\Description\Parameter|null  $parent) : self

Set the parent object of the parameter

Parameters

Returns

getProperties()

getProperties() : array

Get the properties of the parameter

Returns

getProperty()

getProperty(string  $name) : null|\Guzzle\Service\Description\Parameter

Get a specific property from the parameter

Parameters

Returns

removeProperty()

removeProperty(string  $name) : self

Remove a property from the parameter

Parameters

Returns

addProperty()

addProperty(\Guzzle\Service\Description\Parameter  $property) : self

Add a property to the parameter

Parameters

Returns

getAdditionalProperties()

getAdditionalProperties() : boolean|\Guzzle\Service\Description\Parameter|null

Get the additionalProperties value of the parameter

Returns

setAdditionalProperties()

setAdditionalProperties(boolean|\Guzzle\Service\Description\Parameter|null  $additional) : self

Set the additionalProperties value of the parameter

Parameters

Returns

setItems()

setItems(\Guzzle\Service\Description\Parameter|null  $items = null) : self

Set the items data of the parameter

Parameters

Returns

getItems()

getItems() : \Guzzle\Service\Description\Parameter|null

Get the item data of the parameter

Returns

getInstanceOf()

getInstanceOf() : null|string

Get the class that the parameter must implement

Returns

setInstanceOf()

setInstanceOf(string|null  $instanceOf) : self

Set the class that the parameter must be an instance of

Parameters

Returns

getEnum()

getEnum() : array|null

Get the enum of strings that are valid for the parameter

Returns

setEnum()

setEnum(array|null  $enum = null) : self

Set the enum of strings that are valid for the parameter

Parameters

Returns

getPattern()

getPattern() : string

Get the regex pattern that must match a value when the value is a string

Returns

setPattern()

setPattern(string  $pattern) : self

Set the regex pattern that must match a value when the value is a string

Parameters

Returns

getFormat()

getFormat() : string

Get the format attribute of the schema

Returns

setFormat()

setFormat(string  $format) : self

Set the format attribute of the schema

Parameters

Returns