1. class
  2. Hypervel
  3. \
  4. Auth
  5. \
  6. TokenGuard

TokenGuard

class TokenGuard implements Guard

Traits

GuardHelpers

These methods are typically the same across all guards.

Macroable

Properties

protected null|TProvider $provider

The user provider implementation.

 from  GuardHelpers
static protected array $macros

The registered string macros.

 from  Macroable
protected int $hashSeed

The seed for request credential context keys.

Methods

Authenticatable
authenticate()

Determine if the current user is authenticated. If not, throw an exception.

from  GuardHelpers
bool
check()

Determine if the current user is authenticated.

from  GuardHelpers
bool
guest()

Determine if the current user is a guest.

from  GuardHelpers
int|string|null
id()

Get the ID for the currently authenticated user.

from  GuardHelpers
UserProvider|null
getProvider()

Get the user provider used by the guard.

from  GuardHelpers
void
setProvider(UserProvider $provider)

Set the user provider used by the guard.

from  GuardHelpers
string
contextKey(string $key)

Get this guard's coroutine context key for the given entry.

from  GuardHelpers
static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(string $name, UserProvider $provider, Container $app, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

Create a new authentication guard.

Authenticatable|null
user()

Get the currently authenticated user.

string|null
getTokenForRequest()

Get the token for the current request.

bool
validate(array $credentials = [])

Validate a user's credentials.

bool
hasUser()

Determine if the guard has a user instance.

Guard
setUser(Authenticatable $user)

Set the current user.

TokenGuard
forgetUser()

Forget the current user.

array
getAuthContextKeys()

Get durable authentication Context keys.

string
getExplicitUserContextKey()

Get the Context key for an explicitly assigned user.

string
getContextKeyForToken(string|null $token)

Get the Context key for caching the authenticated user, keyed by token.

static void
flushState()

Flush all static state.

Details

in GuardHelpers at line 55
Authenticatable authenticate()

Determine if the current user is authenticated. If not, throw an exception.

Return Value

Authenticatable

Exceptions

AuthenticationException

in GuardHelpers at line 63
bool check()

Determine if the current user is authenticated.

Return Value

bool

in GuardHelpers at line 71
bool guest()

Determine if the current user is a guest.

Return Value

bool

in GuardHelpers at line 79
int|string|null id()

Get the ID for the currently authenticated user.

Return Value

int|string|null

in GuardHelpers at line 89
UserProvider|null getProvider()

Get the user provider used by the guard.

Return Value

UserProvider|null

in GuardHelpers at line 102
void setProvider(UserProvider $provider)

Set the user provider used by the guard.

The provider is stored on the worker-lifetime guard and affects every subsequent request.

Parameters

UserProvider $provider

Return Value

void

in GuardHelpers at line 111
protected string contextKey(string $key)

Get this guard's coroutine context key for the given entry.

Parameters

string $key

Return Value

string

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 39
__construct(string $name, UserProvider $provider, Container $app, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

Create a new authentication guard.

Parameters

string $name
UserProvider $provider
Container $app
string $inputKey

the name of the query string item from the request containing the API token
string $storageKey

the name of the token "column" in persistent storage
bool $hash

indicates if the API token is hashed in storage

at line 58
Authenticatable|null user()

Get the currently authenticated user.

RequestContext keeps resolved users local to the coroutine and clears them when its request changes. Token fingerprints separate credentials, and a sentinel caches "no user found" to avoid redundant provider lookups.

Return Value

Authenticatable|null

at line 97
string|null getTokenForRequest()

Get the token for the current request.

Return Value

string|null

at line 127
bool validate(array $credentials = [])

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

at line 143
bool hasUser()

Determine if the guard has a user instance.

Return Value

bool

at line 161
Guard setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

Guard

at line 173
TokenGuard forgetUser()

Forget the current user.

Return Value

TokenGuard

at line 188
array getAuthContextKeys()

Get durable authentication Context keys.

Per-request token resolution caches must not cross a request boundary.

Return Value

array

at line 196
protected string getExplicitUserContextKey()

Get the Context key for an explicitly assigned user.

Return Value

string

at line 204
protected string getContextKeyForToken(string|null $token)

Get the Context key for caching the authenticated user, keyed by token.

Parameters

string|null $token

Return Value

string

at line 216
static void flushState()

Flush all static state.

Return Value

void