trait AuthenticatesUsers (View source)

Traits

Methods

string
redirectPath()

Get the post register / login redirect path.

getLogin()

Show the application login form.

showLoginForm()

Show the application login form.

postLogin(Request $request)

Handle a login request to the application.

login(Request $request)

Handle a login request to the application.

void
validateLogin(Request $request)

Validate the user login request.

handleUserWasAuthenticated(Request $request, bool $throttles)

Send the response after the user was authenticated.

sendFailedLoginResponse(Request $request)

Get the failed login response instance.

string
getFailedLoginMessage()

Get the failed login message.

array
getCredentials(Request $request)

Get the needed authorization credentials from the request.

getLogout()

Log the user out of the application.

logout()

Log the user out of the application.

guestMiddleware()

Get the guest middleware for the application.

string
loginUsername()

Get the login username to be used by the controller.

bool
isUsingThrottlesLoginsTrait()

Determine if the class is using the ThrottlesLogins trait.

string|null
getGuard()

Get the guard to be used during authentication.

Details

string redirectPath()

Get the post register / login redirect path.

Return Value

string

Response getLogin()

Show the application login form.

Return Value

Response

Response showLoginForm()

Show the application login form.

Return Value

Response

Response postLogin(Request $request)

Handle a login request to the application.

Parameters

Request $request

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 Response handleUserWasAuthenticated(Request $request, bool $throttles)

Send the response after the user was authenticated.

Parameters

Request $request
bool $throttles

Return Value

Response

protected Response sendFailedLoginResponse(Request $request)

Get the failed login response instance.

Parameters

Request $request

Return Value

Response

protected string getFailedLoginMessage()

Get the failed login message.

Return Value

string

protected array getCredentials(Request $request)

Get the needed authorization credentials from the request.

Parameters

Request $request

Return Value

array

Response getLogout()

Log the user out of the application.

Return Value

Response

Response logout()

Log the user out of the application.

Return Value

Response

guestMiddleware()

Get the guest middleware for the application.

string loginUsername()

Get the login username to be used by the controller.

Return Value

string

protected bool isUsingThrottlesLoginsTrait()

Determine if the class is using the ThrottlesLogins trait.

Return Value

bool

protected string|null getGuard()

Get the guard to be used during authentication.

Return Value

string|null