\Guzzle\Service\DescriptionOperation

__construct()

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

Builds an Operation object using an array of configuration data: - name: (string) Name of the command - httpMethod: (string) HTTP method of the operation - uri: (string) URI template that can create a relative or absolute URL - class: (string) Concrete class that implements this command - parameters: (array) Associative array of parameters for the command. {@see Parameter} for information.

• summary: (string) This is a short summary of what the operation does
• notes: (string) A longer text field to explain the behavior of the operation.
• documentationUrl: (string) Reference URL providing more information about the operation
• responseClass: (string) This is what is returned from the method. Can be a primitive, PSR-0 compliant class name, or model.
• responseNotes: (string) Information about the response returned by the operation
• responseType: (string) One of 'primitive', 'class', 'model', or 'documentation'. If not specified, this value will be automatically inferred based on whether or not there is a model matching the name, if a matching PSR-0 compliant class name is found, or set to 'primitive' by default.
• deprecated: (bool) Set to true if this is a deprecated command
• errorResponses: (array) Errors that could occur when executing the command. Array of hashes, each with a 'code' (the HTTP response code), 'reason' (response reason phrase or description of the error), and 'class' (a custom exception class that would be thrown if the error is encountered).
• data: (array) Any extra data that might be used to help build or serialize the operation
• additionalParameters: (null|array) Parameter schema to use when an option is passed to the operation that is not in the schema

Parameters

toArray()

toArray() 

getServiceDescription()

getServiceDescription() : \Guzzle\Service\Description\ServiceDescriptionInterface|null

Get the service description that the operation belongs to

Returns

setServiceDescription()

setServiceDescription(\Guzzle\Service\Description\ServiceDescriptionInterface  $description) : self

Set the service description that the operation belongs to

Parameters

Returns

getParams()

getParams() : array

Get the params of the operation

Returns

getParamNames()

getParamNames() : array

Returns an array of parameter names

Returns

hasParam()

hasParam(string  $name) : boolean

Check if the operation has a specific parameter by name

Parameters

Returns

getParam()

getParam(string  $param) : \Guzzle\Service\Description\Parameter|null

Get a single parameter of the operation

Parameters

Returns

addParam()

addParam(\Guzzle\Service\Description\Parameter  $param) : self

Add a parameter to the command

Parameters

Returns

removeParam()

removeParam(string  $name) : self

Remove a parameter from the command

Parameters

Returns

getHttpMethod()

getHttpMethod() : string|null

Get the HTTP method of the operation

Returns

setHttpMethod()

setHttpMethod(string  $httpMethod) : self

Set the HTTP method of the command

Parameters

Returns

getClass()

getClass() : string

Get the concrete operation class that implements this operation

Returns

setClass()

setClass(string  $className) : self

Set the concrete class of the command

Parameters

Returns

getName()

getName() : string|null

Get the name of the operation

Returns

setName()

setName(string  $name) : self

Set the name of the command

Parameters

Returns

getSummary()

getSummary() : string|null

Get a short summary of what the operation does

Returns

setSummary()

setSummary(string  $summary) : self

Set a short summary of what the operation does

Parameters

Returns

getNotes()

getNotes() : string|null

Get a longer text field to explain the behavior of the operation

Returns

setNotes()

setNotes(string  $notes) : self

Set a longer text field to explain the behavior of the operation.

Parameters

Returns

getDocumentationUrl()

getDocumentationUrl() : string|null

Get the documentation URL of the operation

Returns

setDocumentationUrl()

setDocumentationUrl(string  $docUrl) : self

Set the URL pointing to additional documentation on the command

Parameters

Returns

getResponseClass()

getResponseClass() : string|null

Get what is returned from the method. Can be a primitive, class name, or model. For example, the responseClass could be 'array', which would inherently use a responseType of 'primitive'. Using a class name would set a responseType of 'class'. Specifying a model by ID will use a responseType of 'model'.

Returns

setResponseClass()

setResponseClass(string  $responseClass) : self

Set what is returned from the method. Can be a primitive, class name, or model. For example: 'array', 'Guzzle\\Foo\\Baz', or 'MyModelName' (to reference a model by ID).

Parameters

Returns

getResponseType()

getResponseType() : string

Get information about how the response is unmarshalled: One of 'primitive', 'class', 'model', or 'documentation'

Returns

setResponseType()

setResponseType(string  $responseType) : self

Set qualifying information about the responseClass. One of 'primitive', 'class', 'model', or 'documentation'

Parameters

Throws

\Guzzle\Common\Exception\InvalidArgumentException

Returns

getResponseNotes()

getResponseNotes() : string|null

Get notes about the response of the operation

Returns

setResponseNotes()

setResponseNotes(string  $notes) : self

Set notes about the response of the operation

Parameters

Returns

getDeprecated()

getDeprecated() : boolean

Get whether or not the operation is deprecated

Returns

setDeprecated()

setDeprecated(boolean  $isDeprecated) : self

Set whether or not the command is deprecated

Parameters

Returns

getUri()

getUri() : string

Get the URI that will be merged into the generated request

Returns

setUri()

setUri(string  $uri) : self

Set the URI template of the command

Parameters

Returns

getErrorResponses()

getErrorResponses() : array

Get the errors that could be encountered when executing the operation

Returns

addErrorResponse()

addErrorResponse(string  $code, string  $reason, string  $class) : self

Add an error to the command

Parameters

Returns

setErrorResponses()

setErrorResponses(array  $errorResponses) : self

Set all of the error responses of the operation

Parameters

Returns

getData()

getData(string  $name) : mixed|null

Get extra data from the operation

Parameters

Returns

setData()

setData(string  $name, mixed  $value) : self

Set a particular data point on the operation

Parameters

Returns

getAdditionalParameters()

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

Get the additionalParameters of the operation

Returns

setAdditionalParameters()

setAdditionalParameters(\Guzzle\Service\Description\Parameter|null  $parameter) : self

Set the additionalParameters of the operation

Parameters

Returns

inferResponseType()

inferResponseType() 

Infer the response type from the responseClass value