VuFind API Documentation

ScopeRepository
in package
implements ScopeRepositoryInterface

OAuth2 scope repository implementation.

Tags
category

VuFind

author

Ere Maijala ere.maijala@helsinki.fi

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Site

Interfaces, Classes, Traits and Enums

ScopeRepositoryInterface

Table of Contents

$oauth2Config  : array<string|int, mixed>
OAuth2 server configuration
__construct()  : mixed
Constructor
finalizeScopes()  : array<string|int, ScopeEntityInterface>
Given a client, grant type and optional user identifier validate the set of scopes requested are valid and optionally append additional scopes or remove requested scopes.
getScopeEntityByIdentifier()  : ScopeEntityInterface|null
Return information about a scope.

Properties

$oauth2Config

OAuth2 server configuration

protected array<string|int, mixed> $oauth2Config = []

Methods

__construct()

Constructor

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>

OAuth2 configuration

Return values
mixed

finalizeScopes()

Given a client, grant type and optional user identifier validate the set of scopes requested are valid and optionally append additional scopes or remove requested scopes.

public finalizeScopes(array<string|int, ScopeEntityInterface$scopes, string $grantType, ClientEntityInterface $clientEntity[, null|string $userIdentifier = null ]) : array<string|int, ScopeEntityInterface>
Parameters
$scopes : array<string|int, ScopeEntityInterface>

Scopes

$grantType : string

Grant type

$clientEntity : ClientEntityInterface

Client

$userIdentifier : null|string = null

User ID

Tags
SuppressWarnings

(PHPMD.UnusedFormalParameter)

Return values
array<string|int, ScopeEntityInterface>

getScopeEntityByIdentifier()

Return information about a scope.

public getScopeEntityByIdentifier(string $identifier) : ScopeEntityInterface|null
Parameters
$identifier : string

The scope identifier

Return values
ScopeEntityInterface|null

Search results