1. interface
  2. Illuminate
  3. Contracts
  4. Auth
  5. StatefulGuard

StatefulGuard

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
Authenticatable|null
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 = array())

Validate a user's credentials.

from Guard
void
setUser( Authenticatable $user)

Set the current user.

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

Attempt to authenticate a user using the given credentials.

bool
once( array $credentials = array())

Log a user into the application without sessions or cookies.

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

Log a user into the application.

Authenticatable
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

in Guard at line line 12
bool check()

Determine if the current user is authenticated.

Return Value

bool

in Guard at line line 19
bool guest()

Determine if the current user is a guest.

Return Value

bool

in Guard at line line 26
Authenticatable|null user()

Get the currently authenticated user.

Return Value

Authenticatable|null

in Guard at line line 33
int|null id()

Get the ID for the currently authenticated user.

Return Value

int|null

in Guard at line line 41
bool validate( array $credentials = array())

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

in Guard at line line 49
void setUser( Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

void

at line line 15
bool attempt( array $credentials = array(), 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

at line line 23
bool once( array $credentials = array())

Log a user into the application without sessions or cookies.

Parameters

array $credentials

Return Value

bool

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

Log a user into the application.

Parameters

Authenticatable $user
bool $remember

Return Value

void

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

Log the given user ID into the application.

Parameters

mixed $id
bool $remember

Return Value

Authenticatable

at line line 49
bool onceUsingId( mixed $id)

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

Parameters

mixed $id

Return Value

bool

at line line 56
bool viaRemember()

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

Return Value

bool

at line line 63
void logout()

Log the user out of the application.

Return Value

void