diff options
Diffstat (limited to 'library/oauth2/src/OAuth2/ScopeInterface.php')
-rw-r--r-- | library/oauth2/src/OAuth2/ScopeInterface.php | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/library/oauth2/src/OAuth2/ScopeInterface.php b/library/oauth2/src/OAuth2/ScopeInterface.php new file mode 100644 index 000000000..5b60f9aee --- /dev/null +++ b/library/oauth2/src/OAuth2/ScopeInterface.php @@ -0,0 +1,40 @@ +<?php + +namespace OAuth2; + +use OAuth2\Storage\ScopeInterface as ScopeStorageInterface; + +/** + * Class to handle scope implementation logic + * + * @see OAuth2\Storage\ScopeInterface + */ +interface ScopeInterface extends ScopeStorageInterface +{ + /** + * Check if everything in required scope is contained in available scope. + * + * @param $required_scope + * A space-separated string of scopes. + * + * @return + * TRUE if everything in required scope is contained in available scope, + * and FALSE if it isn't. + * + * @see http://tools.ietf.org/html/rfc6749#section-7 + * + * @ingroup oauth2_section_7 + */ + public function checkScope($required_scope, $available_scope); + + /** + * Return scope info from request + * + * @param OAuth2\RequestInterface + * Request object to check + * + * @return + * string representation of requested scope + */ + public function getScopeFromRequest(RequestInterface $request); +} |