class SessionGuard extends GuardContract (View source)

Traits

Properties

protected string $guard

The define guard

from  GuardContract

Methods

mixed
id()

Get the user id

bool
check()

Check if user is authenticated

bool
guest()

Check if user is guest

bool
logout()

Make direct logout

bool
login(Authentication $user)

Make direct login

Authentication|null
user()

Check if user is authenticated

bool
attempts(array $credentials)

Check if user is authenticated

string
getName()

Get the guard name

guard(string $guard = null)

Load the guard

__construct(array $provider, string $guard)

SessionGuard constructor.

Details

mixed id()

Get the user id

Return Value

mixed

Exceptions

SessionException

bool check()

Check if user is authenticated

Return Value

bool

Exceptions

SessionException

bool guest()

Check if user is guest

Return Value

bool

Exceptions

SessionException

bool logout()

Make direct logout

Return Value

bool

Exceptions

AuthenticationException

bool login(Authentication $user)

Make direct login

Parameters

Authentication $user

Return Value

bool

Exceptions

SessionException

Authentication|null user()

Check if user is authenticated

Return Value

Authentication|null

Exceptions

SessionException

bool attempts(array $credentials)

Check if user is authenticated

Parameters

array $credentials

Return Value

bool

Exceptions

SessionException

string getName()

Get the guard name

Return Value

string

GuardContract guard(string $guard = null)

Load the guard

Parameters

string $guard

Return Value

GuardContract

Exceptions

AuthenticationException

__construct(array $provider, string $guard)

SessionGuard constructor.

Parameters

array $provider
string $guard