class Guard implements Guard (View source)
protected Authenticatable | $user | The currently authenticated user. | |
protected Authenticatable | $lastAttempted | The user we last attempted to retrieve. | |
protected bool | $viaRemember | Indicates if the user was authenticated via a recaller cookie. | |
protected UserProvider | $provider | The user provider implementation. | |
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. |
void | __construct(UserProvider $provider, SessionInterface $session, Request $request = null) Create a new authentication guard. | |
bool | check() Determine if the current user is authenticated. | |
bool | guest() Determine if the current user is a guest. | |
Authenticatable|null | user() Get the currently authenticated user. | |
int|null | id() Get the ID for 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(string $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') Attempt to authenticate using HTTP Basic Auth. | |
Response|null | onceBasic(string $field = 'email') Perform a stateless HTTP Basic login attempt. | |
bool | attemptBasic(Request $request, string $field) 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 | 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 | 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. | |
void | setUser(Authenticatable $user) Set the current 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. |
Create a new authentication guard.
Determine if the current user is authenticated.
Determine if the current user is a guest.
Get the currently authenticated user.
Get the ID for the currently authenticated user.
Pull a user from the repository by its recaller ID.
Get the decrypted recaller cookie for the request.
Get the user ID from the recaller cookie.
Determine if the recaller cookie is in a valid format.
Log a user 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.
Fire the attempt event with the arguments.
Register an authentication attempt event listener.
Log a user into the application.
Fire the login event if the dispatcher is set.
Update the session with the given ID.
Log the given user ID into the application.
Log the given user ID into the application without sessions or cookies.
Queue the recaller cookie into the cookie jar.
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.
Refresh the "remember me" token for the user.
Create a new "remember me" token for the user if one doesn't already exist.
Get the cookie creator instance used by the guard.
Set the cookie creator instance used by the guard.
Get the event dispatcher instance.
Set the event dispatcher instance.
Get the session store used by the guard.
Get the user provider used by the guard.
Set the user provider used by the guard.
Return the currently cached user.
Set the current user.
Get the current request instance.
Set the current request instance.
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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Auth/Guard.html