trait AuthenticatesUsers (View source)

Traits

Methods

string
redirectPath()

Get the post register / login redirect path.

bool
hasTooManyLoginAttempts(Request $request)

Determine if the user has too many failed login attempts.

void
incrementLoginAttempts(Request $request)

Increment the login attempts for the user.

void
sendLockoutResponse(Request $request)

Redirect the user after determining they are locked out.

void
clearLoginAttempts(Request $request)

Clear the login locks for the given user credentials.

void
fireLockoutEvent(Request $request)

Fire an event when a lockout occurs.

string
throttleKey(Request $request)

Get the throttle key for the given request.

limiter()

Get the rate limiter instance.

int
maxAttempts()

Get the maximum number of attempts to allow.

int
decayMinutes()

Get the number of minutes to throttle for.

showLoginForm()

Show the application's login form.

login(Request $request)

Handle a login request to the application.

void
validateLogin(Request $request)

Validate the user login request.

bool
attemptLogin(Request $request)

Attempt to log the user into the application.

array
credentials(Request $request)

Get the needed authorization credentials from the request.

sendLoginResponse(Request $request)

Send the response after the user was authenticated.

mixed
authenticated(Request $request, mixed $user)

The user has been authenticated.

Response
sendFailedLoginResponse(Request $request)

Get the failed login response instance.

string
username()

Get the login username to be used by the controller.

logout(Request $request)

Log the user out of the application.

mixed
loggedOut(Request $request)

The user has logged out of the application.

guard()

Get the guard to be used during authentication.

Details

string redirectPath()

Get the post register / login redirect path.

Return Value

string

protected bool hasTooManyLoginAttempts(Request $request)

Determine if the user has too many failed login attempts.

Parameters

Request $request

Return Value

bool

protected void incrementLoginAttempts(Request $request)

Increment the login attempts for the user.

Parameters

Request $request

Return Value

void

protected void sendLockoutResponse(Request $request)

Redirect the user after determining they are locked out.

Parameters

Request $request

Return Value

void

Exceptions

ValidationException

protected void clearLoginAttempts(Request $request)

Clear the login locks for the given user credentials.

Parameters

Request $request

Return Value

void

protected void fireLockoutEvent(Request $request)

Fire an event when a lockout occurs.

Parameters

Request $request

Return Value

void

protected string throttleKey(Request $request)

Get the throttle key for the given request.

Parameters

Request $request

Return Value

string

protected RateLimiter limiter()

Get the rate limiter instance.

Return Value

RateLimiter

int maxAttempts()

Get the maximum number of attempts to allow.

Return Value

int

int decayMinutes()

Get the number of minutes to throttle for.

Return Value

int

Response showLoginForm()

Show the application's login form.

Return Value

Response

RedirectResponse|Response|JsonResponse login(Request $request)

Handle a login request to the application.

Parameters

Request $request

Return Value

RedirectResponse|Response|JsonResponse

Exceptions

ValidationException

protected void validateLogin(Request $request)

Validate the user login request.

Parameters

Request $request

Return Value

void

protected bool attemptLogin(Request $request)

Attempt to log the user into the application.

Parameters

Request $request

Return Value

bool

protected array credentials(Request $request)

Get the needed authorization credentials from the request.

Parameters

Request $request

Return Value

array

protected Response sendLoginResponse(Request $request)

Send the response after the user was authenticated.

Parameters

Request $request

Return Value

Response

protected mixed authenticated(Request $request, mixed $user)

The user has been authenticated.

Parameters

Request $request
mixed $user

Return Value

mixed

protected Response sendFailedLoginResponse(Request $request)

Get the failed login response instance.

Parameters

Request $request

Return Value

Response

Exceptions

ValidationException

string username()

Get the login username to be used by the controller.

Return Value

string

Response logout(Request $request)

Log the user out of the application.

Parameters

Request $request

Return Value

Response

protected mixed loggedOut(Request $request)

The user has logged out of the application.

Parameters

Request $request

Return Value

mixed

protected StatefulGuard guard()

Get the guard to be used during authentication.

Return Value

StatefulGuard