interface Guard (View source)

Methods

bool
check()

Determine if the current user is authenticated.

bool
guest()

Determine if the current user is a guest.

user()

Get the currently authenticated user.

int|string|null
id()

Get the ID for the currently authenticated user.

bool
validate(array $credentials = [])

Validate a user's credentials.

bool
hasUser()

Determine if the guard has a user instance.

void
setUser(Authenticatable $user)

Set the current user.

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|string|null id()

Get the ID for the currently authenticated user.

Return Value

int|string|null

bool validate(array $credentials = [])

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

bool hasUser()

Determine if the guard has a user instance.

Return Value

bool

void setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

void