SessionGuard
class SessionGuard implements StatefulGuard, SupportsBasicAuth
Traits
These methods are typically the same across all guards.
Properties
| protected Authenticatable | $user | The currently authenticated user. |
from GuardHelpers |
| protected UserProvider | $provider | The user provider implementation. |
from GuardHelpers |
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected string | $name | The name of the Guard. Typically "session". |
|
| protected Authenticatable | $lastAttempted | The user we last attempted to retrieve. |
|
| protected bool | $viaRemember | Indicates if the user was authenticated via a recaller cookie. |
|
| protected Session | $session | The session used by the guard. |
|
| protected QueueingFactory | $cookie | The Illuminate cookie creator service. |
|
| protected Request | $request | The request instance. |
|
| protected Dispatcher | $events | The event dispatcher instance. |
|
| protected bool | $loggedOut | Indicates if the logout method has been called. |
|
| protected bool | $recallAttempted | Indicates if a token user retrieval has been attempted. |
Methods
Get the ID for the currently authenticated user.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Create a new authentication guard.
Get the currently authenticated user.
Pull a user from the repository by its "remember me" cookie token.
Log a user into the application without sessions or cookies.
Log the given user ID into the application without sessions or cookies.
Validate a user's credentials.
Attempt to authenticate using HTTP Basic Auth.
Perform a stateless HTTP Basic login attempt.
Attempt to authenticate using basic authentication.
Get the credential array for a HTTP Basic request.
Get the response for basic authentication.
Attempt to authenticate a user using the given credentials.
Determine if the user matches the credentials.
Log the given user ID into the application.
Update the session with the given ID.
Create a new "remember me" token for the user if one doesn't already exist.
Create a "remember me" cookie for a given ID.
Log the user out of the application.
Remove the user data from the session and cookies.
Register an authentication attempt event listener.
Fire the attempt event with the arguments.
Fire the login event if the dispatcher is set.
Fire the authenticated event if the dispatcher is set.
Fire the failed authentication attempt event with the given arguments.
Get the last user we attempted to authenticate.
Get a unique identifier for the auth session value.
Get the name of the cookie used to store the "recaller".
Determine if the user was authenticated via "remember me" cookie.
Get the cookie creator instance used by the guard.
Get the event dispatcher instance.
Get the session store used by the guard.
Get the user provider used by the guard.
Return the currently cached user.
Get the current request instance.
Set the current request instance.
Details
in
GuardHelpers at line 33
Authenticatable
authenticate()
Determine if the current user is authenticated.
in
GuardHelpers at line 47
bool
check()
Determine if the current user is authenticated.
in
GuardHelpers at line 57
bool
guest()
Determine if the current user is a guest.
at line 201
int|null
id()
Get the ID for the currently authenticated user.
at line 742
void
setUser(Authenticatable $user)
Set the current user.
in
Macroable at line 24
static void
macro(string $name, callable $macro)
Register a custom macro.
in
Macroable at line 35
static bool
hasMacro(string $name)
Checks if macro is registered.
in
Macroable at line 49
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 71
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 96
void
__construct(string $name, UserProvider $provider, Session $session, Request $request = null)
Create a new authentication guard.
at line 112
Authenticatable|null
user()
Get the currently authenticated user.
at line 162
protected mixed
userFromRecaller(Recaller $recaller)
Pull a user from the repository by its "remember me" cookie token.
at line 185
protected Recaller|null
recaller()
Get the decrypted recaller cookie for the request.
at line 218
bool
once(array $credentials = [])
Log a user into the application without sessions or cookies.
at line 237
bool
onceUsingId(mixed $id)
Log the given user ID into the application without sessions or cookies.
at line 254
bool
validate(array $credentials = [])
Validate a user's credentials.
at line 268
Response|null
basic(string $field = 'email', array $extraConditions = [])
Attempt to authenticate using HTTP Basic Auth.
at line 291
Response|null
onceBasic(string $field = 'email', array $extraConditions = [])
Perform a stateless HTTP Basic login attempt.
at line 308
protected bool
attemptBasic(Request $request, string $field, array $extraConditions = [])
Attempt to authenticate using basic authentication.
at line 326
protected array
basicCredentials(Request $request, string $field)
Get the credential array for a HTTP Basic request.
at line 336
protected Response
failedBasicResponse()
Get the response for basic authentication.
at line 348
bool
attempt(array $credentials = [], bool $remember = false)
Attempt to authenticate a user using the given credentials.
at line 378
protected bool
hasValidCredentials(mixed $user, array $credentials)
Determine if the user matches the credentials.
at line 390
Authenticatable
loginUsingId(mixed $id, bool $remember = false)
Log the given user ID into the application.
at line 408
void
login(Authenticatable $user, bool $remember = false)
Log a user into the application.
at line 435
protected void
updateSession(string $id)
Update the session with the given ID.
at line 448
protected void
ensureRememberTokenIsSet(Authenticatable $user)
Create a new "remember me" token for the user if one doesn't already exist.
at line 461
protected void
queueRecallerCookie(Authenticatable $user)
Queue the recaller cookie into the cookie jar.
at line 474
protected Cookie
createRecaller(string $value)
Create a "remember me" cookie for a given ID.
at line 484
void
logout()
Log the user out of the application.
at line 514
protected void
clearUserDataFromStorage()
Remove the user data from the session and cookies.
at line 530
protected void
cycleRememberToken(Authenticatable $user)
Refresh the "remember me" token for the user.
at line 543
void
attempting(mixed $callback)
Register an authentication attempt event listener.
at line 557
protected void
fireAttemptEvent(array $credentials, bool $remember = false)
Fire the attempt event with the arguments.
at line 573
protected void
fireLoginEvent(Authenticatable $user, bool $remember = false)
Fire the login event if the dispatcher is set.
at line 586
protected void
fireAuthenticatedEvent(Authenticatable $user)
Fire the authenticated event if the dispatcher is set.
at line 600
protected void
fireFailedEvent(Authenticatable|null $user, array $credentials)
Fire the failed authentication attempt event with the given arguments.
at line 612
Authenticatable
getLastAttempted()
Get the last user we attempted to authenticate.
at line 622
string
getName()
Get a unique identifier for the auth session value.
at line 632
string
getRecallerName()
Get the name of the cookie used to store the "recaller".
at line 642
bool
viaRemember()
Determine if the user was authenticated via "remember me" cookie.
at line 654
QueueingFactory
getCookieJar()
Get the cookie creator instance used by the guard.
at line 669
void
setCookieJar(QueueingFactory $cookie)
Set the cookie creator instance used by the guard.
at line 679
Dispatcher
getDispatcher()
Get the event dispatcher instance.
at line 690
void
setDispatcher(Dispatcher $events)
Set the event dispatcher instance.
at line 700
Store
getSession()
Get the session store used by the guard.
at line 710
UserProvider
getProvider()
Get the user provider used by the guard.
at line 721
void
setProvider(UserProvider $provider)
Set the user provider used by the guard.
at line 731
Authenticatable|null
getUser()
Return the currently cached user.
at line 758
Request
getRequest()
Get the current request instance.
at line 769
$this
setRequest(Request $request)
Set the current request instance.