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

Fonctions membres publiques statiques

static fromString ($key, $token, $assertClaims=array())
 
static fromCookie ($key, $cookieName, $assertClaims=array())
 
static fromRequest ($key, $attributeName, $assertClaims=array())
 
static fromHeader ($key, $assertClaims=array(), $headerName='Authorization')
 

Documentation des fonctions membres

◆ fromCookie()

static fromCookie (   $key,
  $cookieName,
  $assertClaims = array() 
)
static

Validate and decode a JSON Web Token string from a cookie

Paramètres
KeyAbstract | string$keythe key to use to sign the token, or name of key to build
string$cookieNamename of cookie that sources the token
array | \Traversable$assertClaimstraversable set of claims, claim => value, to assert
Renvoie
\stdClass|false payload as stdClass, or false if token was invalid
Exceptions
+ Voici le graphe d'appel pour cette fonction :
+ Voici le graphe des appelants de cette fonction :

◆ fromHeader()

static fromHeader (   $key,
  $assertClaims = array(),
  $headerName = 'Authorization' 
)
static

Validate and decode a JSON Web Token string from a header

Paramètres
KeyAbstract | string$keythe key to use to sign the token, or name of key to build
array | \Traversable$assertClaimstraversable set of claims, claim => value, to assert
string$headerNamename of header that sources the token
Renvoie
\stdClass|false payload as stdClass, or false if token was invalid
Exceptions
+ Voici le graphe d'appel pour cette fonction :

◆ fromRequest()

static fromRequest (   $key,
  $attributeName,
  $assertClaims = array() 
)
static

Validate and decode a JSON Web Token string from a request (i.e. POST body)

Paramètres
KeyAbstract | string$keythe key to use to sign the token, or name of key to build
string$attributeNamename of cookie that sources the token
array | \Traversable$assertClaimstraversable set of claims, claim => value, to assert
Renvoie
\stdClass|false payload as stdClass, or false if token was invalid
Exceptions
+ Voici le graphe d'appel pour cette fonction :

◆ fromString()

static fromString (   $key,
  $token,
  $assertClaims = array() 
)
static

Validate and decode a JSON Web Token string

Paramètres
KeyAbstract | string$keythe key to use to sign the token, or name of key to build
string$tokenthe token string to validate and decode
array | \Traversable$assertClaimstraversable set of claims, claim => value, to assert
Renvoie
\stdClass|false payload as stdClass, or false if token was invalid
Exceptions
+ Voici le graphe d'appel pour cette fonction :

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