Documentation

JWTService
in package

Service pour la gestion des JWT (JSON Web Tokens).

Table of Contents

check()  : bool
Vérifie la signature d'un token.
generate()  : string
Génère un token JWT.
getHeader()  : array<string|int, mixed>
Récupère le header d'un token.
getPayload()  : array<string|int, mixed>
Récupère le payload d'un token.
isExpired()  : bool
Vérifie si un token a expiré.
isValid()  : bool
Vérifie si un token est valide (correctement formé).

Methods

check()

Vérifie la signature d'un token.

public check(string $token, string $secret) : bool
Parameters
$token : string

Le token à vérifier.

$secret : string

Le secret utilisé pour la génération de la signature.

Return values
bool

True si la signature du token est valide, sinon false.

generate()

Génère un token JWT.

public generate(array<string|int, mixed> $header, array<string|int, mixed> $payload, string $secret[, int $validity = 10800 ]) : string
Parameters
$header : array<string|int, mixed>

Les données du header du token.

$payload : array<string|int, mixed>

Les données du payload du token.

$secret : string

Le secret utilisé pour la génération de la signature.

$validity : int = 10800

La durée de validité du token en secondes.

Return values
string

Le token JWT généré.

getHeader()

Récupère le header d'un token.

public getHeader(string $token) : array<string|int, mixed>
Parameters
$token : string

Le token à partir duquel extraire le header.

Return values
array<string|int, mixed>

Le tableau associatif représentant le header.

getPayload()

Récupère le payload d'un token.

public getPayload(string $token) : array<string|int, mixed>
Parameters
$token : string

Le token à partir duquel extraire le payload.

Return values
array<string|int, mixed>

Le tableau associatif représentant le payload.

isExpired()

Vérifie si un token a expiré.

public isExpired(string $token) : bool
Parameters
$token : string

Le token à vérifier.

Return values
bool

True si le token a expiré, sinon false.

isValid()

Vérifie si un token est valide (correctement formé).

public isValid(string $token) : bool
Parameters
$token : string

Le token à vérifier.

Return values
bool

True si le token est valide, sinon false.

Search results