Interface ServiceDescriptionInterface
A ServiceDescription stores service information based on a service document
- Guzzle\Service\Description\ServiceDescriptionInterface implements Serializable
Direct known implementers
Located at Guzzle/Service/Description/ServiceDescriptionInterface.php
Methods summary
-
publicgetBaseUrl ( )Get the basePath/baseUrl of the description
-
publicgetOperations ( )Get the API operations of the service
-
publichasOperation ( string $name )Check if the service has an operation by name
-
publicgetOperation ( string $name )Get an API operation by name
-
publicgetModel ( string $id )Get a specific model from the description
-
publicgetModels ( )Get all service description models
-
publichasModel ( string $id )Check if the description has a specific model by name
-
publicgetApiVersion ( )Get the API version of the service
-
publicgetName ( )Get the name of the API
-
publicgetDescription ( )Get a summary of the purpose of the API
-
publicgetData ( string $key )Get arbitrary data from the service description that is not part of the Guzzle spec
-
publicsetData ( string $key, mixed $value )Set arbitrary data on the service description
Methods detail
Get the basePath/baseUrl of the description
Returns
stringGet the API operations of the service
Returns
Check if the service has an operation by name
Parameters
- $name
string
$name Name of the operation to check
Returns
booleanGet an API operation by name
Parameters
- $name
string
$name Name of the command
Returns
Get a specific model from the description
Parameters
- $id
string
$id ID of the model
Returns
Get all service description models
Returns
arrayCheck if the description has a specific model by name
Parameters
- $id
string
$id ID of the model
Returns
booleanGet the API version of the service
Returns
stringGet the name of the API
Returns
stringGet a summary of the purpose of the API
Returns
stringGet arbitrary data from the service description that is not part of the Guzzle spec
Parameters
- $key
string
$key Data key to retrieve
Returns
null|mixed
public
Guzzle\Service\Description\ServiceDescriptionInterface
setData( string $key, mixed $value )
Set arbitrary data on the service description
Parameters
- $key
string
$key Data key to set- $value
mixed
$value Value to set