VuFind API Documentation

ClientRepository
in package
implements ClientRepositoryInterface

OAuth2 client 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

ClientRepositoryInterface

Table of Contents

$oauth2Config  : array<string|int, mixed>
OAuth2 server configuration
__construct()  : mixed
Constructor
getClientEntity()  : ClientEntityInterface|null
Get a client.
validateClient()  : bool
Validate a client's secret.

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

getClientEntity()

Get a client.

public getClientEntity(string $clientIdentifier) : ClientEntityInterface|null
Parameters
$clientIdentifier : string

The client's identifier

Return values
ClientEntityInterface|null

validateClient()

Validate a client's secret.

public validateClient(string $clientIdentifier, null|string $clientSecret, null|string $grantType) : bool
Parameters
$clientIdentifier : string

The client's identifier

$clientSecret : null|string

The client's secret (if sent)

$grantType : null|string

The type of grant the client is using (if sent)

Return values
bool

Search results