\Guzzle\Service\DescriptionOperationInterface

Interface defining data objects that hold the information of an API operation

Summary

Methods

Constants

toArray()
getServiceDescription()
setServiceDescription()
getParams()
getParamNames()
hasParam()
getParam()
getHttpMethod()
getClass()
getName()
getSummary()
getNotes()
getDocumentationUrl()
getResponseClass()
getResponseType()
getResponseNotes()
getDeprecated()
getUri()
getErrorResponses()
getData()

TYPE_PRIMITIVE
TYPE_CLASS
TYPE_DOCUMENTATION
TYPE_MODEL

No protected methods found

N/A

No private methods found

N/A

Constants

TYPE_PRIMITIVE

TYPE_PRIMITIVE = 'primitive'

TYPE_CLASS

TYPE_CLASS = 'class'

TYPE_DOCUMENTATION

TYPE_DOCUMENTATION = 'documentation'

TYPE_MODEL

TYPE_MODEL = 'model'

Methods

toArray()

toArray() : array

Get the array representation of an object

Returns

array

getServiceDescription()

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

Get the service description that the operation belongs to

Returns

\Guzzle\Service\Description\ServiceDescriptionInterface|null

setServiceDescription()

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

Set the service description that the operation belongs to

Parameters

\Guzzle\Service\Description\ServiceDescriptionInterface

$description

Service description

Returns

self

getParams()

getParams() : array

Get the params of the operation

Returns

array

getParamNames()

getParamNames() : array

Returns an array of parameter names

Returns

array

hasParam()

hasParam(string  $name) : boolean

Check if the operation has a specific parameter by name

Parameters

string

$name

Name of the param

Returns

boolean

getParam()

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

Get a single parameter of the operation

Parameters

string

$param

Parameter to retrieve by name

Returns

\Guzzle\Service\Description\Parameter|null

getHttpMethod()

getHttpMethod() : string|null

Get the HTTP method of the operation

Returns

string|null

getClass()

getClass() : string

Get the concrete operation class that implements this operation

Returns

string

getName()

getName() : string|null

Get the name of the operation

Returns

string|null

getSummary()

getSummary() : string|null

Get a short summary of what the operation does

Returns

string|null

getNotes()

getNotes() : string|null

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

Returns

string|null

getDocumentationUrl()

getDocumentationUrl() : string|null

Get the documentation URL of the operation

Returns

string|null

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

string|null

getResponseType()

getResponseType() : string

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

Returns

string

getResponseNotes()

getResponseNotes() : string|null

Get notes about the response of the operation

Returns

string|null

getDeprecated()

getDeprecated() : boolean

Get whether or not the operation is deprecated

Returns

boolean

getUri()

getUri() : string

Get the URI that will be merged into the generated request

Returns

string

getErrorResponses()

getErrorResponses() : array

Get the errors that could be encountered when executing the operation

Returns

array

getData()

getData(string  $name) : mixed|null

Get extra data from the operation

Parameters

string

$name

Name of the data point to retrieve

Returns

mixed|null