Updated ScopeInterface with get method

This commit is contained in:
Alex Bilbie 2013-01-29 14:25:49 +00:00
parent 1ed4c27420
commit 5e91b95cb3

View File

@ -4,5 +4,29 @@ namespace OAuth2\Storage;
interface ScopeInterface interface ScopeInterface
{ {
/**
* Return information about a scope
*
* Example SQL query:
*
* <code>
* SELECT * FROM scopes WHERE scope = $scope
* </code>
*
* Response:
*
* <code>
* Array
* (
* [id] => (int) The scope's ID
* [scope] => (string) The scope itself
* [name] => (string) The scope's name
* [description] => (string) The scope's description
* )
* </code>
*
* @param string $scope The scope
* @return bool|array If the scope doesn't exist return false
*/
public function get($scope);
} }