1. interface
  2. Hypervel
  3. \
  4. Jwt
  5. \
  6. Contracts
  7. \
  8. ManagerContract

ManagerContract

interface ManagerContract

Methods

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.

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

Refresh a token.

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

Invalidate a token.

bool
hasBlacklistEnabled()

Determine if the blacklist is enabled.

Details

at line 12
string encode(array $payload)

Encode a payload into a token.

Parameters

array $payload

Return Value

string

at line 17
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 22
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 33
bool invalidate(string $token, bool $forceForever = false)

Invalidate a token.

Parameters

string $token
bool $forceForever

Return Value

bool

at line 38
bool hasBlacklistEnabled()

Determine if the blacklist is enabled.

Return Value

bool