\Guzzle\Service\DescriptionServiceDescriptionInterface

A ServiceDescription stores service information based on a service document

Summary

Methods

Constants

getBaseUrl()
getOperations()
hasOperation()
getOperation()
getModel()
getModels()
hasModel()
getApiVersion()
getName()
getDescription()
getData()
setData()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

getBaseUrl()

getBaseUrl() : string

Get the basePath/baseUrl of the description

Returns

string

getOperations()

getOperations() : array

Get the API operations of the service

Returns

array —

Returns an array of {@see OperationInterface} objects

hasOperation()

hasOperation(string  $name) : boolean

Check if the service has an operation by name

Parameters

string

$name

Name of the operation to check

Returns

boolean

getOperation()

getOperation(string  $name) : \Guzzle\Service\Description\OperationInterface|null

Get an API operation by name

Parameters

string

$name

Name of the command

Returns

\Guzzle\Service\Description\OperationInterface|null

getModel()

getModel(string  $id) : \Guzzle\Service\Description\Parameter|null

Get a specific model from the description

Parameters

string

$id

ID of the model

Returns

\Guzzle\Service\Description\Parameter|null

getModels()

getModels() : array

Get all service description models

Returns

array

hasModel()

hasModel(string  $id) : boolean

Check if the description has a specific model by name

Parameters

string

$id

ID of the model

Returns

boolean

getApiVersion()

getApiVersion() : string

Get the API version of the service

Returns

string

getName()

getName() : string

Get the name of the API

Returns

string

getDescription()

getDescription() : string

Get a summary of the purpose of the API

Returns

string

getData()

getData(string  $key) : null|mixed

Get arbitrary data from the service description that is not part of the Guzzle spec

Parameters

string

$key

Data key to retrieve

Returns

null|mixed

setData()

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

Set arbitrary data on the service description

Parameters

string	$key	Data key to set
mixed	$value	Value to set

Returns

self