XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Référence de la classe JsonWebToken

Fonctions membres publiques

 __construct (KeyAbstract $key, $algorithm='HS256')
 
 setAlgorithm ($algorithm)
 
 decode ($jwtString, $assertClaims=array())
 
 create ($payload, $expirationOffset=0)
 

Attributs protégés

 $key
 
 $algorithm = 'HS256'
 
 $claims = array()
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( KeyAbstract  $key,
  $algorithm = 'HS256' 
)

JsonWebToken constructor.

Paramètres
KeyAbstract$keykey for signing/validating
string$algorithmalgorithm to use for signing/validating
+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

◆ create()

create (   $payload,
  $expirationOffset = 0 
)

Create a signed token string for a payload

Paramètres
array | \ArrayObject$payloadtraversable set of claims, claim => value
int$expirationOffsetseconds from now that token will expire. If not specified, an "exp" claim will not be added or updated
Renvoie
string encoded and signed jwt string
Exceptions
+ Voici le graphe d'appel pour cette fonction :

◆ decode()

decode (   $jwtString,
  $assertClaims = array() 
)

Decode a JWT string, validating signature and well defined registered claims, and optionally validate against a list of supplied claims

Paramètres
string$jwtStringstring containing the JWT to decode
array | \Traversable$assertClaimsassociative array, claim => value, of claims to assert
Renvoie
object|false
+ Voici le graphe d'appel pour cette fonction :

◆ setAlgorithm()

setAlgorithm (   $algorithm)
Paramètres
string$algorithmalgorithm to use for signing/validating
Renvoie
JsonWebToken
Exceptions
+ Voici le graphe des appelants de cette fonction :

Documentation des champs

◆ $algorithm

$algorithm = 'HS256'
protected

◆ $claims

$claims = array()
protected

◆ $key

$key
protected

La documentation de cette classe a été générée à partir du fichier suivant :