1. interface
  2. Illuminate
  3. \
  4. Contracts
  5. \
  6. Auth
  7. \
  8. Guard

Guard

interface Guard (View source)

Methods

bool
check()

Determine if the current user is authenticated.

bool
guest()

Determine if the current user is a guest.

Authenticatable|null
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.

$this
setUser(Authenticatable $user)

Set the current user.

Details

at line 12
bool check()

Determine if the current user is authenticated.

Return Value

bool

at line 19
bool guest()

Determine if the current user is a guest.

Return Value

bool

at line 26
Authenticatable|null user()

Get the currently authenticated user.

Return Value

Authenticatable|null

at line 33
int|string|null id()

Get the ID for the currently authenticated user.

Return Value

int|string|null

at line 41
bool validate(array $credentials = [])

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

at line 48
bool hasUser()

Determine if the guard has a user instance.

Return Value

bool

at line 56
$this setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

$this