TokenGuard
class TokenGuard implements Guard
Traits
These methods are typically the same across all guards.
Properties
| protected UserProvider|null | $provider | The user provider implementation. |
from GuardHelpers |
| static protected array | $macros | The registered string macros. |
from Macroable |
Methods
Determine if the current user is authenticated. If not, throw an exception.
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new authentication guard.
Get the currently authenticated user.
Get the token for the current request.
Validate a user's credentials.
Determine if the guard has a user instance.
Forget the current user.
Get durable authentication Context keys for the current request.
Get the Context key for caching the authenticated user, keyed by token.
Flush all static state.
Details
in
GuardHelpers at line 32
Authenticatable
authenticate()
Determine if the current user is authenticated. If not, throw an exception.
in
GuardHelpers at line 40
bool
check()
Determine if the current user is authenticated.
in
GuardHelpers at line 48
bool
guest()
Determine if the current user is a guest.
in
GuardHelpers at line 56
int|string|null
id()
Get the ID for the currently authenticated user.
in
GuardHelpers at line 64
UserProvider|null
getProvider()
Get the user provider used by the guard.
in
GuardHelpers at line 75
void
setProvider(UserProvider $provider)
Set the user provider used by the guard.
Boot or tests only. The provider is stored on the worker-lifetime guard and affects every subsequent request.
in
Macroable at line 28
static void
macro(string $name, callable|object $macro)
Register a custom macro.
Boot-only. Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.
in
Macroable at line 41
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
Boot-only. Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.
in
Macroable at line 57
static bool
hasMacro(string $name)
Check if macro is registered.
in
Macroable at line 68
static void
flushMacros()
Flush the existing macros.
Boot or tests only. Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.
in
Macroable at line 78
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 103
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 33
__construct(string $name, UserProvider $provider, Container $app, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)
Create a new authentication guard.
at line 52
Authenticatable|null
user()
Get the currently authenticated user.
Uses coroutine Context to cache the resolved user per-request, keyed by token fingerprint so different tokens don't collide. A sentinel value caches "no user found" so repeated calls don't trigger redundant provider lookups.
at line 84
string|null
getTokenForRequest()
Get the token for the current request.
at line 108
bool
validate(array $credentials = [])
Validate a user's credentials.
at line 122
bool
hasUser()
Determine if the guard has a user instance.
at line 134
Guard
setUser(Authenticatable $user)
Set the current user.
at line 144
TokenGuard
forgetUser()
Forget the current user.
at line 156
array
getAuthContextKeys()
Get durable authentication Context keys for the current request.
at line 164
protected string
getContextKeyForToken(string|null $token)
Get the Context key for caching the authenticated user, keyed by token.
at line 176
static void
flushState()
Flush all static state.