\OAuth2ScopeInterface

Class to handle scope implementation logic

Summary

Methods
Constants
scopeExists()
getDefaultScope()
checkScope()
getScopeFromRequest()
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

checkScope()

checkScope(string  $required_scope, string  $available_scope) : boolean

Check if everything in required scope is contained in available scope.

Parameters

string $required_scope
  • A space-separated string of scopes.
string $available_scope
  • A space-separated string of scopes.

Returns

boolean —
  • TRUE if everything in required scope is contained in available scope and FALSE if it isn't.

getScopeFromRequest()

getScopeFromRequest(\OAuth2\RequestInterface  $request) : string

Return scope info from request

Parameters

\OAuth2\RequestInterface $request
  • Request object to check

Returns

string —
  • representation of requested scope