\OAuth2\StorageScopeInterface

Implement this interface to specify where the OAuth2 Server should retrieve data involving the relevent scopes associated with this implementation.

Summary

Methods
Constants
scopeExists()
getDefaultScope()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

scopeExists()

scopeExists(  $scope) : TRUE

Check if the provided scope exists.

Parameters

$scope

A space-separated string of scopes.

Returns

TRUE —

if it exists, FALSE otherwise.

getDefaultScope()

getDefaultScope(  $client_id = null) : string

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