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

GuardHelpers

trait GuardHelpers (View source)

These methods are typically the same across all guards.

Properties

protected Authenticatable|null $user

The currently authenticated user.
protected UserProvider $provider

The user provider implementation.

Methods

Authenticatable
authenticate()

Determine if the current user is authenticated. If not, throw an exception.

bool
hasUser()

Determine if the guard has a user instance.

bool
check()

Determine if the current user is authenticated.

bool
guest()

Determine if the current user is a guest.

int|string|null
id()

Get the ID for the currently authenticated user.

$this
setUser(Authenticatable $user)

Set the current user.

$this
forgetUser()

Forget the current user.

UserProvider
getProvider()

Get the user provider used by the guard.

void
setProvider(UserProvider $provider)

Set the user provider used by the guard.

Details

at line 34
Authenticatable authenticate()

Determine if the current user is authenticated. If not, throw an exception.

Return Value

Authenticatable

Exceptions

AuthenticationException

at line 44
bool hasUser()

Determine if the guard has a user instance.

Return Value

bool

at line 54
bool check()

Determine if the current user is authenticated.

Return Value

bool

at line 64
bool guest()

Determine if the current user is a guest.

Return Value

bool

at line 74
int|string|null id()

Get the ID for the currently authenticated user.

Return Value

int|string|null

at line 87
$this setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

$this

at line 99
$this forgetUser()

Forget the current user.

Return Value

$this

at line 111
UserProvider getProvider()

Get the user provider used by the guard.

Return Value

UserProvider

at line 122
void setProvider(UserProvider $provider)

Set the user provider used by the guard.

Parameters

UserProvider $provider

Return Value

void