1. class
  2. Illuminate
  3. \
  4. Auth
  5. \
  6. TokenGuard

TokenGuard

class TokenGuard implements Guard (View source)

Traits

GuardHelpers

These methods are typically the same across all guards.

Macroable

Properties

protected Authenticatable|null $user

The currently authenticated user.

 from  GuardHelpers
protected UserProvider $provider

The user provider implementation.

 from  GuardHelpers
static protected array $macros

The registered string macros.

 from  Macroable
protected Request $request

The request instance.
protected string $inputKey

The name of the query string item from the request containing the API token.
protected string $storageKey

The name of the token "column" in persistent storage.
protected bool $hash

Indicates if the API token is hashed in storage.

Methods

Authenticatable
authenticate()

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

from  GuardHelpers
bool
hasUser()

Determine if the guard has a user instance.

from  GuardHelpers
bool
check()

Determine if the current user is authenticated.

from  GuardHelpers
bool
guest()

Determine if the current user is a guest.

from  GuardHelpers
int|string|null
id()

Get the ID for the currently authenticated user.

from  GuardHelpers
$this
setUser(Authenticatable $user)

Set the current user.

from  GuardHelpers
$this
forgetUser()

Forget the current user.

from  GuardHelpers
UserProvider
getProvider()

Get the user provider used by the guard.

from  GuardHelpers
void
setProvider(UserProvider $provider)

Set the user provider used by the guard.

from  GuardHelpers
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(UserProvider $provider, Request $request, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

Create a new authentication guard.

Authenticatable|null
user()

Get the currently authenticated user.

string|null
getTokenForRequest()

Get the token for the current request.

bool
validate(array $credentials = [])

Validate a user's credentials.

$this
setRequest(Request $request)

Set the current request instance.

Details

in GuardHelpers at line 34
Authenticatable authenticate()

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

Return Value

Authenticatable

Exceptions

AuthenticationException

in GuardHelpers at line 44
bool hasUser()

Determine if the guard has a user instance.

Return Value

bool

in GuardHelpers at line 54
bool check()

Determine if the current user is authenticated.

Return Value

bool

in GuardHelpers at line 64
bool guest()

Determine if the current user is a guest.

Return Value

bool

in GuardHelpers at line 74
int|string|null id()

Get the ID for the currently authenticated user.

Return Value

int|string|null

in GuardHelpers at line 87
$this setUser(Authenticatable $user)

Set the current user.

Parameters

Authenticatable $user

Return Value

$this

in GuardHelpers at line 99
$this forgetUser()

Forget the current user.

Return Value

$this

in GuardHelpers at line 111
UserProvider getProvider()

Get the user provider used by the guard.

Return Value

UserProvider

in GuardHelpers at line 122
void setProvider(UserProvider $provider)

Set the user provider used by the guard.

Parameters

UserProvider $provider

Return Value

void

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 51
__construct(UserProvider $provider, Request $request, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

Create a new authentication guard.

Parameters

UserProvider $provider
Request $request
string $inputKey
string $storageKey
bool $hash

at line 70
Authenticatable|null user()

Get the currently authenticated user.

Return Value

Authenticatable|null

at line 97
string|null getTokenForRequest()

Get the token for the current request.

Return Value

string|null

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

Validate a user's credentials.

Parameters

array $credentials

Return Value

bool

at line 143
$this setRequest(Request $request)

Set the current request instance.

Parameters

Request $request

Return Value

$this