Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres protégées | Fonctions membres privées | Attributs privés
Référence de la classe Builder

Fonctions membres publiques

 __construct (Encoder $encoder=null, ClaimFactory $claimFactory=null)
 
 canOnlyBeUsedBy ($audience, $replicateAsHeader=false)
 
 permittedFor (... $audiences)
 
 setAudience ($audience, $replicateAsHeader=false)
 
 expiresAt ($expiration, $replicateAsHeader=false)
 
 setExpiration ($expiration, $replicateAsHeader=false)
 
 identifiedBy ($id, $replicateAsHeader=false)
 
 setId ($id, $replicateAsHeader=false)
 
 issuedAt ($issuedAt, $replicateAsHeader=false)
 
 setIssuedAt ($issuedAt, $replicateAsHeader=false)
 
 issuedBy ($issuer, $replicateAsHeader=false)
 
 setIssuer ($issuer, $replicateAsHeader=false)
 
 canOnlyBeUsedAfter ($notBefore, $replicateAsHeader=false)
 
 setNotBefore ($notBefore, $replicateAsHeader=false)
 
 relatedTo ($subject, $replicateAsHeader=false)
 
 setSubject ($subject, $replicateAsHeader=false)
 
 withHeader ($name, $value)
 
 setHeader ($name, $value)
 
 with ($name, $value)
 
 withClaim ($name, $value)
 
 set ($name, $value)
 
 sign (Signer $signer, $key)
 
 unsign ()
 
 getToken (Signer $signer=null, Key $key=null)
 

Fonctions membres protégées

 setRegisteredClaim ($name, $value, $replicate)
 

Fonctions membres privées

 convertToDate ($value)
 
 configureClaim ($name, $value)
 
 forwardCallToCorrectClaimMethod ($name, $value)
 
 convertItems (array $items)
 
 createSignature ($payload, Signer $signer=null, Key $key=null)
 

Attributs privés

 $headers = ['typ'=> 'JWT'
 
 $claims = []
 
 $encoder
 
 $claimFactory
 
 $signer
 
 $key
 

Description détaillée

This class makes easier the token creation process

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 ( Encoder  $encoder = null,
ClaimFactory  $claimFactory = null 
)

Initializes a new builder

Paramètres
Encoder$encoder
ClaimFactory$claimFactory

Références Builder\$claimFactory, et Builder\$encoder.

Documentation des fonctions membres

◆ canOnlyBeUsedAfter()

canOnlyBeUsedAfter (   $notBefore,
  $replicateAsHeader = false 
)

Configures the time before which the token cannot be accepted

Paramètres
int | DateTimeImmutable$notBefore
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\convertToDate(), et Builder\setRegisteredClaim().

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setNotBefore().

◆ canOnlyBeUsedBy()

canOnlyBeUsedBy (   $audience,
  $replicateAsHeader = false 
)

Configures the audience

Obsolète:
This method has been wrongly added and doesn't exist on v4
Voir également
Builder::permittedFor()
Paramètres
string$audience
bool$replicateAsHeader
Renvoie
Builder

Références Builder\permittedFor().

◆ configureClaim()

configureClaim (   $name,
  $value 
)
private
Paramètres
string$name
mixed$value
Renvoie
Builder

Références $name, $this, et $value.

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setRegisteredClaim().

◆ convertItems()

convertItems ( array  $items)
private
Paramètres
array<string,mixed>$items
Renvoie
array<string, mixed>

Références $items, $name, RegisteredClaims\AUDIENCE, et RegisteredClaims\DATE_CLAIMS.

◆ convertToDate()

convertToDate (   $value)
private
Paramètres
int | DateTimeImmutable$value
Renvoie
DateTimeImmutable

Références $value.

Référencé par Builder\canOnlyBeUsedAfter(), Builder\expiresAt(), et Builder\issuedAt().

◆ createSignature()

createSignature (   $payload,
Signer  $signer = null,
Key  $key = null 
)
private
Paramètres
string$payload
Renvoie
Signature

Références $hash, Builder\$key, Builder\$signer, Signature\fromEmptyData(), et null.

Référencé par Builder\getToken().

◆ expiresAt()

expiresAt (   $expiration,
  $replicateAsHeader = false 
)

Configures the expiration time

Paramètres
int | DateTimeImmutable$expiration
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\convertToDate(), et Builder\setRegisteredClaim().

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setExpiration().

◆ forwardCallToCorrectClaimMethod()

forwardCallToCorrectClaimMethod (   $name,
  $value 
)
private

Références $name, $value, RegisteredClaims\AUDIENCE, Builder\canOnlyBeUsedAfter(), Builder\configureClaim(), RegisteredClaims\EXPIRATION_TIME, Builder\expiresAt(), RegisteredClaims\ID, Builder\identifiedBy(), RegisteredClaims\ISSUED_AT, Builder\issuedAt(), Builder\issuedBy(), RegisteredClaims\ISSUER, RegisteredClaims\NOT_BEFORE, et Builder\permittedFor().

Référencé par Builder\set(), et Builder\withClaim().

◆ getToken()

getToken ( Signer  $signer = null,
Key  $key = null 
)

Returns the resultant token

Renvoie
Token

Références Builder\$claims, Builder\$headers, Builder\$key, Builder\$signer, $this, Builder\createSignature(), null, et DataSet\toString().

◆ identifiedBy()

identifiedBy (   $id,
  $replicateAsHeader = false 
)

Configures the token id

Paramètres
string$id
boolean$replicateAsHeader
Renvoie
Builder

Références $id, et Builder\setRegisteredClaim().

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setId().

◆ issuedAt()

issuedAt (   $issuedAt,
  $replicateAsHeader = false 
)

Configures the time that the token was issued

Paramètres
int | DateTimeImmutable$issuedAt
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\convertToDate(), et Builder\setRegisteredClaim().

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setIssuedAt().

◆ issuedBy()

issuedBy (   $issuer,
  $replicateAsHeader = false 
)

Configures the issuer

Paramètres
string$issuer
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\setRegisteredClaim().

Référencé par Builder\forwardCallToCorrectClaimMethod(), et Builder\setIssuer().

◆ permittedFor()

permittedFor (   $audiences)

Configures the audience

Paramètres
list<string|bool>$audiences A list of audiences and, optionally, the instruction to replicate as header
Renvoie
Builder

Références RegisteredClaims\AUDIENCE, et Builder\setRegisteredClaim().

Référencé par Builder\canOnlyBeUsedBy(), Builder\forwardCallToCorrectClaimMethod(), et Builder\setAudience().

◆ relatedTo()

relatedTo (   $subject,
  $replicateAsHeader = false 
)

Configures the subject

Paramètres
string$subject
boolean$replicateAsHeader
Renvoie
Builder

Références $subject, et Builder\setRegisteredClaim().

Référencé par Builder\setSubject().

◆ set()

set (   $name,
  $value 
)

Configures a claim item

Obsolète:
This method will be removed on v4
Voir également
Builder::withClaim()
Paramètres
string$name
mixed$value
Renvoie
Builder

Références $name, $value, et Builder\forwardCallToCorrectClaimMethod().

◆ setAudience()

setAudience (   $audience,
  $replicateAsHeader = false 
)

Configures the audience

Obsolète:
This method will be removed on v4
Voir également
Builder::permittedFor()
Paramètres
string$audience
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\permittedFor().

◆ setExpiration()

setExpiration (   $expiration,
  $replicateAsHeader = false 
)

Configures the expiration time

Obsolète:
This method will be removed on v4
Voir également
Builder::expiresAt()
Paramètres
int | DateTimeImmutable$expiration
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\expiresAt().

◆ setHeader()

setHeader (   $name,
  $value 
)

Configures a header item

Obsolète:
This method will be removed on v4
Voir également
Builder::withHeader()
Paramètres
string$name
mixed$value
Renvoie
Builder

Références $name, $value, et Builder\withHeader().

◆ setId()

setId (   $id,
  $replicateAsHeader = false 
)

Configures the token id

Obsolète:
This method will be removed on v4
Voir également
Builder::identifiedBy()
Paramètres
string$id
boolean$replicateAsHeader
Renvoie
Builder

Références $id, et Builder\identifiedBy().

◆ setIssuedAt()

setIssuedAt (   $issuedAt,
  $replicateAsHeader = false 
)

Configures the time that the token was issued

Obsolète:
This method will be removed on v4
Voir également
Builder::issuedAt()
Paramètres
int | DateTimeImmutable$issuedAt
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\issuedAt().

◆ setIssuer()

setIssuer (   $issuer,
  $replicateAsHeader = false 
)

Configures the issuer

Obsolète:
This method will be removed on v4
Voir également
Builder::issuedBy()
Paramètres
string$issuer
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\issuedBy().

◆ setNotBefore()

setNotBefore (   $notBefore,
  $replicateAsHeader = false 
)

Configures the time before which the token cannot be accepted

Obsolète:
This method will be removed on v4
Voir également
Builder::canOnlyBeUsedAfter()
Paramètres
int | DateTimeImmutable$notBefore
boolean$replicateAsHeader
Renvoie
Builder

Références Builder\canOnlyBeUsedAfter().

◆ setRegisteredClaim()

setRegisteredClaim (   $name,
  $value,
  $replicate 
)
protected

Configures a registered claim

Paramètres
string$name
mixed$value
boolean$replicate
Renvoie
Builder

Références $name, $this, $value, et Builder\configureClaim().

Référencé par Builder\canOnlyBeUsedAfter(), Builder\expiresAt(), Builder\identifiedBy(), Builder\issuedAt(), Builder\issuedBy(), Builder\permittedFor(), et Builder\relatedTo().

◆ setSubject()

setSubject (   $subject,
  $replicateAsHeader = false 
)

Configures the subject

Obsolète:
This method will be removed on v4
Voir également
Builder::relatedTo()
Paramètres
string$subject
boolean$replicateAsHeader
Renvoie
Builder

Références $subject, et Builder\relatedTo().

◆ sign()

sign ( Signer  $signer,
  $key 
)

Signs the data

Obsolète:
This method will be removed on v4
Voir également
Builder::getToken()
Paramètres
Signer$signer
Key | string$key
Renvoie
Builder

Références Builder\$key, Builder\$signer, et $this.

◆ unsign()

unsign ( )

Removes the signature from the builder

Obsolète:
This method will be removed on v4
Voir également
Builder::getToken()
Renvoie
Builder

Références $this, et null.

◆ with()

with (   $name,
  $value 
)

Configures a claim item

Obsolète:
This method has been wrongly added and doesn't exist on v4
Voir également
Builder::withClaim()
Paramètres
string$name
mixed$value
Renvoie
Builder

Références $name, $value, et Builder\withClaim().

◆ withClaim()

withClaim (   $name,
  $value 
)

Configures a claim item

Paramètres
string$name
mixed$value
Renvoie
Builder
Exceptions
RegisteredClaimGiven

Références $name, $value, RegisteredClaims\ALL, et Builder\forwardCallToCorrectClaimMethod().

Référencé par Builder\with().

◆ withHeader()

withHeader (   $name,
  $value 
)

Configures a header item

Paramètres
string$name
mixed$value
Renvoie
Builder

Références $name, $this, et $value.

Référencé par Builder\setHeader().

Documentation des champs

◆ $claimFactory

$claimFactory
private

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

◆ $claims

$claims = []
private

Référencé par Builder\getToken().

◆ $encoder

$encoder
private

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

◆ $headers

$headers = ['typ'=> 'JWT'
private

Référencé par Builder\getToken().

◆ $key

$key
private

Référencé par Builder\createSignature(), Builder\getToken(), et Builder\sign().

◆ $signer

$signer
private

Référencé par Builder\createSignature(), Builder\getToken(), et Builder\sign().

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