AuthenticatesUsers

trait AuthenticatesUsers (View source)

Traits

RedirectsUsers
ThrottlesLogins

Methods

string redirectPath()

Get the post register / login redirect path.

from RedirectsUsers
bool hasTooManyLoginAttempts(Request $request)

Determine if the user has too many failed login attempts.

from ThrottlesLogins
int incrementLoginAttempts(Request $request)

Increment the login attempts for the user.

from ThrottlesLogins
RedirectResponse sendLockoutResponse(Request $request)

Redirect the user after determining they are locked out.

from ThrottlesLogins
void clearLoginAttempts(Request $request)

Clear the login locks for the given user credentials.

from ThrottlesLogins
void fireLockoutEvent(Request $request)

Fire an event when a lockout occurs.

from ThrottlesLogins
string throttleKey(Request $request)

Get the throttle key for the given request.

from ThrottlesLogins
RateLimiter limiter()

Get the rate limiter instance.

from ThrottlesLogins
Response showLoginForm()

Show the application's login form.

Response 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.

Response sendLoginResponse(Request $request)

Send the response after the user was authenticated.

mixed authenticated(Request $request, mixed $user)

The user has been authenticated.

RedirectResponse sendFailedLoginResponse(Request $request)

Get the failed login response instance.

string username()

Get the login username to be used by the controller.

Response logout(Request $request)

Log the user out of the application.

StatefulGuard 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 int incrementLoginAttempts(Request $request)

Increment the login attempts for the user.

Parameters

Request $request

Return Value

int

protected RedirectResponse sendLockoutResponse(Request $request)

Redirect the user after determining they are locked out.

Parameters

Request $request

Return Value

RedirectResponse

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

Response showLoginForm()

Show the application's login form.

Return Value

Response

Response login(Request $request)

Handle a login request to the application.

Parameters

Request $request

Return Value

Response

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 RedirectResponse sendFailedLoginResponse(Request $request)

Get the failed login response instance.

Parameters

Request $request

Return Value

RedirectResponse

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 StatefulGuard guard()

Get the guard to be used during authentication.

Return Value

StatefulGuard

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Foundation/Auth/AuthenticatesUsers.html