Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Token

Fonctions membres publiques

 __construct ( $headers=['alg'=> 'none'], $claims=[], Signature $signature=null, array $payload=['', ''], Factory $claimFactory=null)
 
 headers ()
 
 getHeaders ()
 
 hasHeader ($name)
 
 getHeader ($name, $default=null)
 
 claims ()
 
 getClaims ()
 
 hasClaim ($name)
 
 getClaim ($name, $default=null)
 
 verify (Signer $signer, $key)
 
 validate (ValidationData $data)
 
 isExpired (DateTimeInterface $now=null)
 
 isPermittedFor ($audience)
 
 isIdentifiedBy ($id)
 
 isRelatedTo ($subject)
 
 hasBeenIssuedBy (... $issuers)
 
 hasBeenIssuedBefore (DateTimeInterface $now)
 
 isMinimumTimeBefore (DateTimeInterface $now)
 
 getPayload ()
 
 payload ()
 
 signature ()
 
 __toString ()
 
 toString ()
 

Fonctions membres privées

 convertToDataSet ($data, $payload)
 
 getValidatableClaims ()
 

Attributs privés

 $headers
 
 $claims
 
 $signature
 
 $claimFactory
 

Description détaillée

Basic structure of the JWT

Auteur
Luís Otávio Cobucci Oblonczyk lcobu.nosp@m.cci@.nosp@m.gmail.nosp@m..com
Depuis
0.1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $headers = ['alg' =,
'none']  ,
  $claims = [],
Signature  $signature = null,
array  $payload = ['',
'']  ,
Factory  $claimFactory = null 
)

Initializes the object

Paramètres
array | DataSet$headers
array | DataSet$claims
Signature | null$signature
array$payload
Factory | null$claimFactory

Références Token\$claimFactory, Token\$claims, Token\$headers, Token\$signature, Token\claims(), Token\convertToDataSet(), Signature\fromEmptyData(), Token\headers(), et Token\signature().

Documentation des fonctions membres

◆ __toString()

__toString ( )

Returns an encoded representation of the token

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::toString()
Renvoie
string

Références Token\toString().

◆ claims()

◆ convertToDataSet()

convertToDataSet (   $data,
  $payload 
)
private
Paramètres
array | DataSet$data
string$payload

Références $data.

Référencé par Token\__construct().

◆ getClaim()

getClaim (   $name,
  $default = null 
)

Returns the value of a token claim

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::claims()
DataSet::get()
Paramètres
string$name
mixed$default
Renvoie
mixed
Exceptions
OutOfBoundsException

Références $default, $name, $value, RegisteredClaims\AUDIENCE, Token\claims(), et RegisteredClaims\DATE_CLAIMS.

◆ getClaims()

getClaims ( )

Returns the token claim set

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::claims()
Renvoie
array

Références $items, $name, $value, et Token\claims().

Référencé par Token\getValidatableClaims().

◆ getHeader()

getHeader (   $name,
  $default = null 
)

Returns the value of a token header

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::headers()
DataSet::has()
Paramètres
string$name
mixed$default
Renvoie
mixed
Exceptions
OutOfBoundsException

Références $default, $name, et Token\headers().

◆ getHeaders()

getHeaders ( )

Returns the token headers

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::headers()
Renvoie
array

Références $items, $name, $value, RegisteredClaims\ALL, Token\claims(), et Token\headers().

◆ getPayload()

getPayload ( )

Returns the token payload

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::payload()
Renvoie
string

Références Token\payload().

Référencé par SignedWith\assert(), et Token\verify().

◆ getValidatableClaims()

getValidatableClaims ( )
private

Yields the validatable claims

Renvoie
Generator

Références Token\getClaims().

Référencé par Token\validate().

◆ hasBeenIssuedBefore()

hasBeenIssuedBefore ( DateTimeInterface  $now)
Paramètres
DateTimeInterface$now
Renvoie
bool

Références $now, Token\claims(), et RegisteredClaims\ISSUED_AT.

Référencé par ValidAt\assertIssueTime().

◆ hasBeenIssuedBy()

hasBeenIssuedBy (   $issuers)
Paramètres
list<string>$issuers
Renvoie
bool

Références Token\claims(), et RegisteredClaims\ISSUER.

Référencé par IssuedBy\assert().

◆ hasClaim()

hasClaim (   $name)

Returns if the claim is configured

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::claims()
DataSet::has()
Paramètres
string$name
Renvoie
boolean

Références $name, et Token\claims().

◆ hasHeader()

hasHeader (   $name)

Returns if the header is configured

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Token::headers()
DataSet::has()
Paramètres
string$name
Renvoie
boolean

Références $name, et Token\headers().

◆ headers()

◆ isExpired()

isExpired ( DateTimeInterface  $now = null)

Determine if the token is expired.

Paramètres
DateTimeInterface | null$nowDefaults to the current time.
Renvoie
bool

Références $now, Token\claims(), RegisteredClaims\EXPIRATION_TIME, et null.

Référencé par ValidAt\assertExpiration().

◆ isIdentifiedBy()

isIdentifiedBy (   $id)
Paramètres
string$id
Renvoie
bool

Références $id, Token\claims(), et RegisteredClaims\ID.

Référencé par IdentifiedBy\assert().

◆ isMinimumTimeBefore()

isMinimumTimeBefore ( DateTimeInterface  $now)
Paramètres
DateTimeInterface$now
Renvoie
bool

Références Token\claims(), et RegisteredClaims\NOT_BEFORE.

Référencé par ValidAt\assertMinimumTime().

◆ isPermittedFor()

isPermittedFor (   $audience)
Paramètres
string$audience
Renvoie
bool

Références RegisteredClaims\AUDIENCE, et Token\claims().

Référencé par PermittedFor\assert().

◆ isRelatedTo()

isRelatedTo (   $subject)
Paramètres
string$subject
Renvoie
bool

Références $subject, Token\claims(), et RegisteredClaims\SUBJECT.

Référencé par RelatedTo\assert().

◆ payload()

payload ( )

Returns the token payload

Renvoie
string

Références Token\claims(), et Token\headers().

Référencé par Token\getPayload().

◆ signature()

signature ( )

◆ toString()

toString ( )
Renvoie
string

Références Token\claims(), Token\headers(), et Token\signature().

Référencé par Token\__toString().

◆ validate()

validate ( ValidationData  $data)

Validates if the token is valid

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Paramètres
ValidationData$data
Renvoie
boolean

Références $data, et Token\getValidatableClaims().

◆ verify()

verify ( Signer  $signer,
  $key 
)

Verify if the key matches with the one that created the signature

Obsolète:
This method has been removed from the interface in v4.0
Voir également
Paramètres
Signer$signer
Key | string$key
Renvoie
boolean

Références $key, Signer\getAlgorithmId(), Token\getPayload(), Token\headers(), et Token\signature().

Documentation des champs

◆ $claimFactory

$claimFactory
private

Référencé par Token\__construct().

◆ $claims

$claims
private

Référencé par Token\__construct(), et Token\claims().

◆ $headers

$headers
private

Référencé par Token\__construct(), et Token\headers().

◆ $signature

$signature
private

Référencé par Token\__construct(), et Token\signature().


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