OAuth2\ScopeInterface Interface Reference

Inheritance diagram for OAuth2\ScopeInterface:

Public Member Functions
	checkScope ($required_scope, $available_scope)
	getScopeFromRequest (RequestInterface $request)
Public Member Functions inherited from OAuth2\Storage\ScopeInterface
	scopeExists ($scope)
	getDefaultScope ($client_id=null)

Detailed Description

Class to handle scope implementation logic

See also

OAuth2\Storage\ScopeInterface

Definition at line 12 of file ScopeInterface.php.

Member Function Documentation

checkScope()

OAuth2\ScopeInterface::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.

See also

http://tools.ietf.org/html/rfc6749#section-7

Implemented in OAuth2\Scope.

getScopeFromRequest()

OAuth2\ScopeInterface::getScopeFromRequest

(

RequestInterface

$request

)

Return scope info from request

Parameters

OAuth2

Implemented in OAuth2\Scope.

---

The documentation for this interface was generated from the following file:

• plugins/OAuth2/ScopeInterface.php