interface StatefulGuard implements Guard (View source)

Methods

bool
check()

Determine if the current user is authenticated.

from Guard
bool
guest()

Determine if the current user is a guest.

from Guard
user()

Get the currently authenticated user.

from Guard
int|null
id()

Get the ID for the currently authenticated user.

from Guard
bool
validate(array $credentials = [])

Validate a user's credentials.

from Guard
void
setUser(Authenticatable $user)

Set the current user.

from Guard
bool
attempt(array $credentials = [], bool $remember = false, bool $login = true)

Attempt to authenticate a user using the given credentials.

bool
once(array $credentials = [])

Log a user into the application without sessions or cookies.

void
login(Authenticatable $user, bool $remember = false)

Log a user into the application.

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.

bool
viaRemember()

Determine if the user was authenticated via "remember me" cookie.

void
logout()

Log the user out of the application.

Details

bool check()

Determine if the current user is authenticated.

Return Value

bool

bool guest()

Determine if the current user is a guest.

Return Value

bool

Authenticatable|null user()

Get the currently authenticated user.

Return Value

Authenticatable|null

int|null id()

Get the ID for the currently authenticated user.

Return Value

int|null

bool validate(array $credentials = [])

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

void setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

void

bool attempt(array $credentials = [], bool $remember = false, bool $login = true)

Attempt to authenticate a user using the given credentials.

Parameters

array $credentials
bool $remember
bool $login

Return Value

bool

bool once(array $credentials = [])

Log a user into the application without sessions or cookies.

Parameters

array $credentials

Return Value

bool

void login(Authenticatable $user, bool $remember = false)

Log a user into the application.

Parameters

Authenticatable $user
bool $remember

Return Value

void

Authenticatable loginUsingId(mixed $id, bool $remember = false)

Log the given user ID into the application.

Parameters

mixed $id
bool $remember

Return Value

Authenticatable

bool onceUsingId(mixed $id)

Log the given user ID into the application without sessions or cookies.

Parameters

mixed $id

Return Value

bool

bool viaRemember()

Determine if the user was authenticated via "remember me" cookie.

Return Value

bool

void logout()

Log the user out of the application.

Return Value

void