1. trait
  2. Illuminate
  3. \
  4. Auth
  5. \
  6. GuardHelpers

GuardHelpers

trait GuardHelpers

These methods are typically the same across all guards.

Properties

protected Authenticatable $user

The currently authenticated user.
protected UserProvider $provider

The user provider implementation.

Methods

Authenticatable
authenticate()

Determine if the current user is authenticated.

bool
check()

Determine if the current user is authenticated.

bool
guest()

Determine if the current user is a guest.

int|null
id()

Get the ID for the currently authenticated user.

$this
setUser(Authenticatable $user)

Set the current user.

Details

at line 33
Authenticatable authenticate()

Determine if the current user is authenticated.

Return Value

Authenticatable

Exceptions

AuthenticationException

at line 47
bool check()

Determine if the current user is authenticated.

Return Value

bool

at line 57
bool guest()

Determine if the current user is a guest.

Return Value

bool

at line 67
int|null id()

Get the ID for the currently authenticated user.

Return Value

int|null

at line 80
$this setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

$this