ServiceDescriptionInterface
extends
Serializable
in
A ServiceDescription stores service information based on a service document
Table of Contents
Methods
- getApiVersion() : string
- Get the API version of the service
- getBaseUrl() : string
- Get the basePath/baseUrl of the description
- getData() : null|mixed
- Get arbitrary data from the service description that is not part of the Guzzle spec
- getDescription() : string
- Get a summary of the purpose of the API
- getModel() : Parameter|null
- Get a specific model from the description
- getModels() : array<string|int, mixed>
- Get all service description models
- getName() : string
- Get the name of the API
- getOperation() : OperationInterface|null
- Get an API operation by name
- getOperations() : array<string|int, mixed>
- Get the API operations of the service
- hasModel() : bool
- Check if the description has a specific model by name
- hasOperation() : bool
- Check if the service has an operation by name
- setData() : self
- Set arbitrary data on the service description
Methods
getApiVersion()
Get the API version of the service
public
getApiVersion() : string
Return values
stringgetBaseUrl()
Get the basePath/baseUrl of the description
public
getBaseUrl() : string
Return values
stringgetData()
Get arbitrary data from the service description that is not part of the Guzzle spec
public
getData(string $key) : null|mixed
Parameters
- $key : string
-
Data key to retrieve
Return values
null|mixedgetDescription()
Get a summary of the purpose of the API
public
getDescription() : string
Return values
stringgetModel()
Get a specific model from the description
public
getModel(string $id) : Parameter|null
Parameters
- $id : string
-
ID of the model
Return values
Parameter|nullgetModels()
Get all service description models
public
getModels() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
Get the name of the API
public
getName() : string
Return values
stringgetOperation()
Get an API operation by name
public
getOperation(string $name) : OperationInterface|null
Parameters
- $name : string
-
Name of the command
Return values
OperationInterface|nullgetOperations()
Get the API operations of the service
public
getOperations() : array<string|int, mixed>
Return values
array<string|int, mixed> —Returns an array of OperationInterface objects
hasModel()
Check if the description has a specific model by name
public
hasModel(string $id) : bool
Parameters
- $id : string
-
ID of the model
Return values
boolhasOperation()
Check if the service has an operation by name
public
hasOperation(string $name) : bool
Parameters
- $name : string
-
Name of the operation to check
Return values
boolsetData()
Set arbitrary data on the service description
public
setData(string $key, mixed $value) : self
Parameters
- $key : string
-
Data key to set
- $value : mixed
-
Value to set