Public Member Functions | |
| getApiVersion () | |
| getBaseUrl () | |
| getData ($key) | |
| getDescription () | |
| getModel ($id) | |
| getModels () | |
| getName () | |
| getOperation ($name) | |
| getOperations () | |
| hasModel ($id) | |
| hasOperation ($name) | |
| setData ($key, $value) | |
Detailed Description
A ServiceDescription stores service information based on a service document
Definition at line 8 of file ServiceDescriptionInterface.php.
Member Function Documentation
◆ getApiVersion()
| Guzzle\Service\Description\ServiceDescriptionInterface::getApiVersion | ( | ) |
Get the API version of the service
- Returns
- string
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getBaseUrl()
| Guzzle\Service\Description\ServiceDescriptionInterface::getBaseUrl | ( | ) |
Get the basePath/baseUrl of the description
- Returns
- string
Implemented in Guzzle\Service\Description\ServiceDescription.
Referenced by Guzzle\Service\Client\setDescription().
◆ getData()
| Guzzle\Service\Description\ServiceDescriptionInterface::getData | ( | $key | ) |
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
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getDescription()
| Guzzle\Service\Description\ServiceDescriptionInterface::getDescription | ( | ) |
Get a summary of the purpose of the API
- Returns
- string
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getModel()
| Guzzle\Service\Description\ServiceDescriptionInterface::getModel | ( | $id | ) |
Get a specific model from the description
- Parameters
-
string $id ID of the model
- Returns
- Parameter|null
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getModels()
| Guzzle\Service\Description\ServiceDescriptionInterface::getModels | ( | ) |
Get all service description models
- Returns
- array
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getName()
| Guzzle\Service\Description\ServiceDescriptionInterface::getName | ( | ) |
◆ getOperation()
| Guzzle\Service\Description\ServiceDescriptionInterface::getOperation | ( | $name | ) |
Get an API operation by name
- Parameters
-
string $name Name of the command
- Returns
- OperationInterface|null
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ getOperations()
| Guzzle\Service\Description\ServiceDescriptionInterface::getOperations | ( | ) |
Get the API operations of the service
- Returns
- array Returns an array of {
- See also
- OperationInterface} objects
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ hasModel()
| Guzzle\Service\Description\ServiceDescriptionInterface::hasModel | ( | $id | ) |
Check if the description has a specific model by name
- Parameters
-
string $id ID of the model
- Returns
- bool
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ hasOperation()
| Guzzle\Service\Description\ServiceDescriptionInterface::hasOperation | ( | $name | ) |
Check if the service has an operation by name
- Parameters
-
string $name Name of the operation to check
- Returns
- bool
Implemented in Guzzle\Service\Description\ServiceDescription.
◆ setData()
| Guzzle\Service\Description\ServiceDescriptionInterface::setData | ( | $key, | |
| $value | |||
| ) |
Set arbitrary data on the service description
- Parameters
-
string $key Data key to set mixed $value Value to set
- Returns
- self
Implemented in Guzzle\Service\Description\ServiceDescription.
The documentation for this interface was generated from the following file:
