JwtManager
class JwtManager extends Manager implements ManagerContract
Traits
Properties
| protected Repository | $config | The configuration repository instance. |
from Manager |
| protected Closure> | $customCreators | The registered custom driver creators. |
from Manager |
| protected array<array-key, mixed> | $drivers | The array of created "drivers". |
from Manager |
| protected BlacklistContract|null | $blacklist | ||
| protected bool | $blacklistEnabled | ||
| protected array | $validations |
Methods
Get the default driver name.
Get the name of the manager's creator method for the given driver.
Dynamically call the default driver instance.
Create an instance of the Lcobucci JWT Driver.
Encode a payload into a token.
Decode a token into its payload.
Run the configured validations against a decoded payload.
Get the cached validation instance for the given class.
Refresh a token.
Decode a token for refresh.
Invalidate a token.
Validate that the token is still refreshable.
Determine if the blacklist is enabled.
Get the blacklist instance.
Details
in
RebindsCallbacksToSelf at line 18
protected Closure|null
bindCallbackToSelf(Closure $callback)
Bind the provided callback to the class instance.
at line 33
__construct(Container $container, ClaimFactory $claimFactory)
Create a new manager instance.
at line 57
string|null
getDefaultDriver()
Get the default driver name.
in
Manager at line 60
mixed
driver(UnitEnum|string|null $driver = null)
Get a driver instance.
in
Manager at line 92
protected mixed
createDriver(string $driver)
Create a new driver instance.
in
Manager at line 113
protected string|null
getCreatorMethod(string $driver)
Get the name of the manager's creator method for the given driver.
in
Manager at line 124
protected mixed
callCustomCreator(string $driver)
Call a custom driver creator.
in
Manager at line 140
Manager
extend(string $driver, Closure $callback)
Register a custom driver creator Closure.
Anonymous closures run in this manager's class scope; non-static closures also receive the manager as $this.
The callback persists in the singleton's customCreators array for the worker lifetime and applies to every subsequent driver resolution.
in
Manager at line 160
array
getDrivers()
Get all of the created "drivers".
in
Manager at line 182
Manager
setContainer(Container $container)
Set the container instance used by the manager.
Swaps the singleton's container and configuration references; per-request use races across coroutines and breaks every concurrent driver resolution through this manager.
in
Manager at line 199
Manager
forgetDrivers()
Forget all of the resolved driver instances.
Clears the singleton's driver cache; concurrent coroutines may already hold references that next resolution will not share.
in
Manager at line 210
mixed
__call(string $method, array $parameters)
Dynamically call the default driver instance.
at line 45
Lcobucci
createLcobucciDriver()
Create an instance of the Lcobucci JWT Driver.
at line 65
string
encode(array $payload)
Encode a payload into a token.
at line 77
array
decode(string $token, bool $validate = true, bool $checkBlacklist = true)
Decode a token into its payload.
at line 95
protected void
validatePayload(array $payload, bool $refresh = false)
Run the configured validations against a decoded payload.
at line 111
protected ValidationContract
getValidation(string $class)
Get the cached validation instance for the given class.
at line 123
string
refresh(string $token, bool $forceForever = false, bool $resetClaims = false, array $customClaims = [], int|false|null $ttl = false)
Refresh a token.
at line 160
protected array
decodeForRefresh(string $token)
Decode a token for refresh.
at line 176
bool
invalidate(string $token, bool $forceForever = false)
Invalidate a token.
at line 197
protected void
validateRefreshWindow(array $payload)
Validate that the token is still refreshable.
at line 228
bool
hasBlacklistEnabled()
Determine if the blacklist is enabled.
at line 236
BlacklistContract
blacklist()
Get the blacklist instance.