SessionGuard
class SessionGuard implements StatefulGuard, SupportsBasicAuth (View source)
Traits
| GuardHelpers | 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 |
| 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 SessionInterface | $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 | $tokenRetrievalAttempted | Indicates if a token user retrieval has been attempted. |
Methods
| Authenticatable | authenticate() Determine if the current user is authenticated. | 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|null | id() Get the ID for the currently authenticated user. | |
| void | setUser(Authenticatable $user) Set the current user. | |
| void | __construct(string $name, UserProvider $provider, SessionInterface $session, Request $request = null) Create a new authentication guard. | |
| Authenticatable|null | user() Get the currently authenticated user. | |
| mixed | getUserByRecaller(string $recaller) Pull a user from the repository by its recaller ID. | |
| string|null | getRecaller() Get the decrypted recaller cookie for the request. | |
| string|null | getRecallerId() Get the user ID from the recaller cookie. | |
| bool | validRecaller(mixed $recaller) Determine if the recaller cookie is in a valid format. | |
| bool | once(array $credentials = []) Log a user into the application without sessions or cookies. | |
| bool | validate(array $credentials = []) Validate a user's credentials. | |
| Response|null | basic(string $field = 'email', array $extraConditions = []) Attempt to authenticate using HTTP Basic Auth. | |
| Response|null | onceBasic(string $field = 'email', array $extraConditions = []) Perform a stateless HTTP Basic login attempt. | |
| bool | attemptBasic(Request $request, string $field, array $extraConditions = []) Attempt to authenticate using basic authentication. | |
| array | getBasicCredentials(Request $request, string $field) Get the credential array for a HTTP Basic request. | |
| Response | getBasicResponse() Get the response for basic authentication. | |
| bool | attempt(array $credentials = [], bool $remember = false, bool $login = true) Attempt to authenticate a user using the given credentials. | |
| bool | hasValidCredentials(mixed $user, array $credentials) Determine if the user matches the credentials. | |
| void | fireAttemptEvent(array $credentials, bool $remember, bool $login) Fire the attempt event with the arguments. | |
| void | fireFailedEvent(Authenticatable|null $user, array $credentials) Fire the failed authentication attempt event with the given arguments. | |
| void | attempting(mixed $callback) Register an authentication attempt event listener. | |
| void | login(Authenticatable $user, bool $remember = false) Log a user into the application. | |
| void | fireLoginEvent(Authenticatable $user, bool $remember = false) Fire the login event if the dispatcher is set. | |
| void | fireAuthenticatedEvent(Authenticatable $user) Fire the authenticated event if the dispatcher is set. | |
| void | updateSession(string $id) Update the session with the given ID. | |
| Authenticatable | loginUsingId(mixed $id, bool $remember = false) Log the given user ID into the application. | |
| bool | onceUsingId(mixed $id) Log the given user ID into the application without sessions or cookies. | |
| void | queueRecallerCookie(Authenticatable $user) Queue the recaller cookie into the cookie jar. | |
| Cookie | createRecaller(string $value) Create a "remember me" cookie for a given ID. | |
| void | logout() Log the user out of the application. | |
| void | clearUserDataFromStorage() Remove the user data from the session and cookies. | |
| void | refreshRememberToken(Authenticatable $user) Refresh the "remember me" token for the user. | |
| void | createRememberTokenIfDoesntExist(Authenticatable $user) Create a new "remember me" token for the user if one doesn't already exist. | |
| QueueingFactory | getCookieJar() Get the cookie creator instance used by the guard. | |
| void | setCookieJar(QueueingFactory $cookie) Set the cookie creator instance used by the guard. | |
| Dispatcher | getDispatcher() Get the event dispatcher instance. | |
| void | setDispatcher(Dispatcher $events) Set the event dispatcher instance. | |
| Store | getSession() Get the session store used by the guard. | |
| UserProvider | getProvider() Get the user provider used by the guard. | |
| void | setProvider(UserProvider $provider) Set the user provider used by the guard. | |
| Authenticatable|null | getUser() Return the currently cached user. | |
| Request | getRequest() Get the current request instance. | |
| $this | setRequest(Request $request) Set the current request instance. | |
| Authenticatable | getLastAttempted() Get the last user we attempted to authenticate. | |
| string | getName() Get a unique identifier for the auth session value. | |
| string | getRecallerName() Get the name of the cookie used to store the "recaller". | |
| bool | viaRemember() Determine if the user was authenticated via "remember me" cookie. |
Details
Authenticatable authenticate()
Determine if the current user is authenticated.
bool check()
Determine if the current user is authenticated.
bool guest()
Determine if the current user is a guest.
int|null id()
Get the ID for the currently authenticated user.
void setUser(Authenticatable $user)
Set the current user.
void __construct(string $name, UserProvider $provider, SessionInterface $session, Request $request = null)
Create a new authentication guard.
Authenticatable|null user()
Get the currently authenticated user.
protected mixed getUserByRecaller(string $recaller)
Pull a user from the repository by its recaller ID.
protected string|null getRecaller()
Get the decrypted recaller cookie for the request.
protected string|null getRecallerId()
Get the user ID from the recaller cookie.
protected bool validRecaller(mixed $recaller)
Determine if the recaller cookie is in a valid format.
bool once(array $credentials = [])
Log a user into the application without sessions or cookies.
bool validate(array $credentials = [])
Validate a user's credentials.
Response|null basic(string $field = 'email', array $extraConditions = [])
Attempt to authenticate using HTTP Basic Auth.
Response|null onceBasic(string $field = 'email', array $extraConditions = [])
Perform a stateless HTTP Basic login attempt.
protected bool attemptBasic(Request $request, string $field, array $extraConditions = [])
Attempt to authenticate using basic authentication.
protected array getBasicCredentials(Request $request, string $field)
Get the credential array for a HTTP Basic request.
protected Response getBasicResponse()
Get the response for basic authentication.
bool attempt(array $credentials = [], bool $remember = false, bool $login = true)
Attempt to authenticate a user using the given credentials.
protected bool hasValidCredentials(mixed $user, array $credentials)
Determine if the user matches the credentials.
protected void fireAttemptEvent(array $credentials, bool $remember, bool $login)
Fire the attempt event with the arguments.
protected void fireFailedEvent(Authenticatable|null $user, array $credentials)
Fire the failed authentication attempt event with the given arguments.
void attempting(mixed $callback)
Register an authentication attempt event listener.
void login(Authenticatable $user, bool $remember = false)
Log a user into the application.
protected void fireLoginEvent(Authenticatable $user, bool $remember = false)
Fire the login event if the dispatcher is set.
protected void fireAuthenticatedEvent(Authenticatable $user)
Fire the authenticated event if the dispatcher is set.
protected void updateSession(string $id)
Update the session with the given ID.
Authenticatable loginUsingId(mixed $id, bool $remember = false)
Log the given user ID into the application.
bool onceUsingId(mixed $id)
Log the given user ID into the application without sessions or cookies.
protected void queueRecallerCookie(Authenticatable $user)
Queue the recaller cookie into the cookie jar.
protected Cookie createRecaller(string $value)
Create a "remember me" cookie for a given ID.
void logout()
Log the user out of the application.
protected void clearUserDataFromStorage()
Remove the user data from the session and cookies.
protected void refreshRememberToken(Authenticatable $user)
Refresh the "remember me" token for the user.
protected void createRememberTokenIfDoesntExist(Authenticatable $user)
Create a new "remember me" token for the user if one doesn't already exist.
QueueingFactory getCookieJar()
Get the cookie creator instance used by the guard.
void setCookieJar(QueueingFactory $cookie)
Set the cookie creator instance used by the guard.
Dispatcher getDispatcher()
Get the event dispatcher instance.
void setDispatcher(Dispatcher $events)
Set the event dispatcher instance.
Store getSession()
Get the session store used by the guard.
UserProvider getProvider()
Get the user provider used by the guard.
void setProvider(UserProvider $provider)
Set the user provider used by the guard.
Authenticatable|null getUser()
Return the currently cached user.
Request getRequest()
Get the current request instance.
$this setRequest(Request $request)
Set the current request instance.
Authenticatable getLastAttempted()
Get the last user we attempted to authenticate.
string getName()
Get a unique identifier for the auth session value.
string getRecallerName()
Get the name of the cookie used to store the "recaller".
bool viaRemember()
Determine if the user was authenticated via "remember me" cookie.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Auth/SessionGuard.html