1. class
  2. Hypervel
  3. \
  4. Jwt
  5. \
  6. JwtManager

JwtManager

class JwtManager extends Manager implements ManagerContract

Traits

RebindsCallbacksToSelf

Properties

protected Repository $config

The configuration repository instance.

 from  Manager
protected array $customCreators

The registered custom driver creators.

 from  Manager
protected array $drivers

The array of created "drivers".

 from  Manager
protected BlacklistContract|null $blacklist
protected bool $blacklistEnabled
protected array $validations

Methods

Closure|null
bindCallbackToSelf(Closure $callback)

Bind the provided callback to the class instance.

from  RebindsCallbacksToSelf
__construct(Container $container, ClaimFactory $claimFactory)

Create a new manager instance.

string
getDefaultDriver()

Get the default driver name.

mixed
driver(UnitEnum|string|null $driver = null)

Get a driver instance.

from  Manager
mixed
createDriver(string $driver)

Create a new driver instance.

from  Manager
mixed
callCustomCreator(string $driver)

Call a custom driver creator.

from  Manager
Manager
extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

from  Manager
array
getDrivers()

Get all of the created "drivers".

from  Manager
Container
getContainer()

Get the container instance used by the manager.

from  Manager
Manager
setContainer(Container $container)

Set the container instance used by the manager.

from  Manager
Manager
forgetDrivers()

Forget all of the resolved driver instances.

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

Dynamically call the default driver instance.

from  Manager
Lcobucci
createLcobucciDriver()

Create an instance of the Lcobucci JWT Driver.

string
encode(array $payload)

Encode a payload into a token.

array
decode(string $token, bool $validate = true, bool $checkBlacklist = true)

Decode a token into its payload.

void
validatePayload(array $payload, bool $refresh = false)

No description

ValidationContract
getValidation(string $class)

No description

string
refresh(string $token, bool $forceForever = false, bool $resetClaims = false, array $customClaims = [], int|false|null $ttl = false)

Refresh a token.

array
decodeForRefresh(string $token)

Decode a token for refresh.

bool
invalidate(string $token, bool $forceForever = false)

Invalidate a token.

void
validateRefreshWindow(array $payload)

Validate that the token is still refreshable.

bool
hasBlacklistEnabled()

Determine if the blacklist is enabled.

BlacklistContract
blacklist()

Get the configured blacklist instance.

Details

in RebindsCallbacksToSelf at line 18
protected Closure|null bindCallbackToSelf(Closure $callback)

Bind the provided callback to the class instance.

Parameters

Closure $callback

Return Value

Closure|null

Exceptions

ReflectionException

at line 32
__construct(Container $container, ClaimFactory $claimFactory)

Create a new manager instance.

Parameters

Container $container
ClaimFactory $claimFactory

at line 65
string getDefaultDriver()

Get the default driver name.

Return Value

string

in Manager at line 53
mixed driver(UnitEnum|string|null $driver = null)

Get a driver instance.

Parameters

UnitEnum|string|null $driver

Return Value

mixed

Exceptions

InvalidArgumentException

in Manager at line 78
protected mixed createDriver(string $driver)

Create a new driver instance.

Parameters

string $driver

Return Value

mixed

Exceptions

InvalidArgumentException

in Manager at line 99
protected mixed callCustomCreator(string $driver)

Call a custom driver creator.

Parameters

string $driver

Return Value

mixed

in Manager at line 112
Manager extend(string $driver, Closure $callback)

Register a custom driver creator Closure.

Boot-only. The callback persists in the singleton's customCreators array for the worker lifetime and applies to every subsequent driver resolution.

Parameters

string $driver
Closure $callback

Return Value

Manager

in Manager at line 129
array getDrivers()

Get all of the created "drivers".

Return Value

array

in Manager at line 137
Container getContainer()

Get the container instance used by the manager.

Return Value

Container

in Manager at line 151
Manager setContainer(Container $container)

Set the container instance used by the manager.

Tests only. Swaps the singleton's container reference; per-request use races across coroutines and breaks every concurrent driver resolution through this manager.

Parameters

Container $container

Return Value

Manager

in Manager at line 167
Manager forgetDrivers()

Forget all of the resolved driver instances.

Boot or tests only. Clears the singleton's driver cache; concurrent coroutines may already hold references that next resolution will not share.

Return Value

Manager

in Manager at line 177
mixed __call(string $method, array $parameters)

Dynamically call the default driver instance.

Parameters

string $method
array $parameters

Return Value

mixed

at line 47
Lcobucci createLcobucciDriver()

Create an instance of the Lcobucci JWT Driver.

Return Value

Lcobucci

at line 73
string encode(array $payload)

Encode a payload into a token.

Parameters

array $payload

Return Value

string

at line 85
array decode(string $token, bool $validate = true, bool $checkBlacklist = true)

Decode a token into its payload.

Parameters

string $token
bool $validate
bool $checkBlacklist

Return Value

array

at line 100
protected void validatePayload(array $payload, bool $refresh = false)

No description

Parameters

array $payload
bool $refresh

Return Value

void

at line 113
protected ValidationContract getValidation(string $class)

No description

Parameters

string $class

Return Value

ValidationContract

at line 125
string refresh(string $token, bool $forceForever = false, bool $resetClaims = false, array $customClaims = [], int|false|null $ttl = false)

Refresh a token.

Parameters

string $token
bool $forceForever
bool $resetClaims
array $customClaims
int|false|null $ttl

Return Value

string

at line 161
protected array decodeForRefresh(string $token)

Decode a token for refresh.

Parameters

string $token

Return Value

array

at line 177
bool invalidate(string $token, bool $forceForever = false)

Invalidate a token.

Parameters

string $token
bool $forceForever

Return Value

bool

at line 192
protected void validateRefreshWindow(array $payload)

Validate that the token is still refreshable.

Parameters

array $payload

Return Value

void

at line 209
bool hasBlacklistEnabled()

Determine if the blacklist is enabled.

Return Value

bool

at line 217
protected BlacklistContract blacklist()

Get the configured blacklist instance.

Return Value

BlacklistContract