diff options
Diffstat (limited to 'vendor/guzzle/guzzle/src/Guzzle/Service/Description/ServiceDescriptionInterface.php')
-rw-r--r-- | vendor/guzzle/guzzle/src/Guzzle/Service/Description/ServiceDescriptionInterface.php | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/vendor/guzzle/guzzle/src/Guzzle/Service/Description/ServiceDescriptionInterface.php b/vendor/guzzle/guzzle/src/Guzzle/Service/Description/ServiceDescriptionInterface.php new file mode 100644 index 0000000..5983e58 --- /dev/null +++ b/vendor/guzzle/guzzle/src/Guzzle/Service/Description/ServiceDescriptionInterface.php @@ -0,0 +1,106 @@ +<?php + +namespace Guzzle\Service\Description; + +/** + * A ServiceDescription stores service information based on a service document + */ +interface ServiceDescriptionInterface extends \Serializable +{ + /** + * Get the basePath/baseUrl of the description + * + * @return string + */ + public function getBaseUrl(); + + /** + * Get the API operations of the service + * + * @return array Returns an array of {@see OperationInterface} objects + */ + public function getOperations(); + + /** + * Check if the service has an operation by name + * + * @param string $name Name of the operation to check + * + * @return bool + */ + public function hasOperation($name); + + /** + * Get an API operation by name + * + * @param string $name Name of the command + * + * @return OperationInterface|null + */ + public function getOperation($name); + + /** + * Get a specific model from the description + * + * @param string $id ID of the model + * + * @return Parameter|null + */ + public function getModel($id); + + /** + * Get all service description models + * + * @return array + */ + public function getModels(); + + /** + * Check if the description has a specific model by name + * + * @param string $id ID of the model + * + * @return bool + */ + public function hasModel($id); + + /** + * Get the API version of the service + * + * @return string + */ + public function getApiVersion(); + + /** + * Get the name of the API + * + * @return string + */ + public function getName(); + + /** + * Get a summary of the purpose of the API + * + * @return string + */ + public function getDescription(); + + /** + * Get arbitrary data from the service description that is not part of the Guzzle spec + * + * @param string $key Data key to retrieve + * + * @return null|mixed + */ + public function getData($key); + + /** + * Set arbitrary data on the service description + * + * @param string $key Data key to set + * @param mixed $value Value to set + * + * @return self + */ + public function setData($key, $value); +} |