Inheritance diagram for OAuth2\Scope:
Public Member Functions | |
| __construct ($storage=null) | |
| checkScope ($required_scope, $available_scope) | |
| scopeExists ($scope) | |
| getScopeFromRequest (RequestInterface $request) | |
| getDefaultScope ($client_id=null) | |
| getReservedScopes () | |
Protected Attributes | |
| $storage | |
Detailed Description
Constructor & Destructor Documentation
◆ __construct()
| OAuth2\Scope::__construct | ( | $storage = null | ) |
Member Function Documentation
◆ checkScope()
| OAuth2\Scope::checkScope | ( | $required_scope, | |
| $available_scope | |||
| ) |
Check if everything in required scope is contained in available scope.
- Parameters
-
$required_scope A space-separated string of scopes.
- Returns
- TRUE if everything in required scope is contained in available scope, and FALSE if it isn't.
Implements OAuth2\ScopeInterface.
◆ getDefaultScope()
| OAuth2\Scope::getDefaultScope | ( | $client_id = null | ) |
The default scope to use in the event the client does not request one. By returning "false", a request_error is returned by the server to force a scope request by the client. By returning "null", opt out of requiring scopes
- Parameters
-
$client_id An optional client id that can be used to return customized default scopes.
- Returns
- string representation of default scope, null if scopes are not defined, or false to force scope request by the client
ex: 'default' ex: null
Implements OAuth2\Storage\ScopeInterface.
◆ getReservedScopes()
| OAuth2\Scope::getReservedScopes | ( | ) |
◆ getScopeFromRequest()
| OAuth2\Scope::getScopeFromRequest | ( | RequestInterface | $request | ) |
◆ scopeExists()
| OAuth2\Scope::scopeExists | ( | $scope | ) |
Check if the provided scope exists in storage.
- Parameters
-
$scope A space-separated string of scopes.
- Returns
- TRUE if it exists, FALSE otherwise.
Implements OAuth2\Storage\ScopeInterface.
Member Data Documentation
◆ $storage
The documentation for this class was generated from the following file:
- plugins/OAuth2/Scope.php
