Authenticable
in package
AbstractYes
Class Authenticable
Tags
Table of Contents
Properties
- $authToken : array<string|int, mixed>
- $options : array<string|int, mixed>
- $restClient : RestClient
Methods
- __construct() : mixed
- Authenticable constructor.
- authenticate() : void
- Authenticates a user on ArangoDB Server
- getAuthorizationHeader() : array<string|int, mixed>
- Return the authorization header
- getAuthenticationEndpoint() : string
- Authentication endpoint for a given database
- getCredentials() : array<string|int, mixed>
- Return authentication credentials
Properties
$authToken
protected
array<string|int, mixed>
$authToken
JWT token
$options
protected
array<string|int, mixed>
$options
$restClient
protected
RestClient
$restClient
Methods
__construct()
Authenticable constructor.
public
__construct(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
Tags
authenticate()
Authenticates a user on ArangoDB Server
protected
authenticate(array<string|int, mixed> $credentials) : void
Parameters
- $credentials : array<string|int, mixed>
Tags
getAuthorizationHeader()
Return the authorization header
protected
getAuthorizationHeader() : array<string|int, mixed>
Return values
array<string|int, mixed>getAuthenticationEndpoint()
Authentication endpoint for a given database
private
getAuthenticationEndpoint() : string
Return values
stringgetCredentials()
Return authentication credentials
private
getCredentials() : array<string|int, mixed>