Joomla CMS
4.2.2
Documentation des API du CMS Joomla en version 4.2.2
|
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 | |
Basic structure of the JWT
__construct | ( | $headers = ['alg' = , |
|
'none'] | , | ||
$claims = [] , |
|||
Signature | $signature = null , |
||
array | $payload = ['' , |
||
''] | , | ||
Factory | $claimFactory = null |
||
) |
Initializes the object
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().
__toString | ( | ) |
Returns an encoded representation of the token
Références Token\toString().
claims | ( | ) |
Références Token\$claims.
Référencé par Token\__construct(), Token\getClaim(), Token\getClaims(), Token\getHeaders(), Token\hasBeenIssuedBefore(), Token\hasBeenIssuedBy(), Token\hasClaim(), Token\isExpired(), Token\isIdentifiedBy(), Token\isMinimumTimeBefore(), Token\isPermittedFor(), Token\isRelatedTo(), Token\payload(), et Token\toString().
|
private |
getClaim | ( | $name, | |
$default = null |
|||
) |
Returns the value of a token claim
string | $name | |
mixed | $default |
OutOfBoundsException |
Références $default, $name, $value, RegisteredClaims\AUDIENCE, Token\claims(), et RegisteredClaims\DATE_CLAIMS.
getClaims | ( | ) |
Returns the token claim set
Références $items, $name, $value, et Token\claims().
Référencé par Token\getValidatableClaims().
getHeader | ( | $name, | |
$default = null |
|||
) |
Returns the value of a token header
string | $name | |
mixed | $default |
OutOfBoundsException |
Références $default, $name, et Token\headers().
getHeaders | ( | ) |
Returns the token headers
Références $items, $name, $value, RegisteredClaims\ALL, Token\claims(), et Token\headers().
getPayload | ( | ) |
Returns the token payload
Références Token\payload().
Référencé par SignedWith\assert(), et Token\verify().
|
private |
Yields the validatable claims
Références Token\getClaims().
Référencé par Token\validate().
hasBeenIssuedBefore | ( | DateTimeInterface | $now | ) |
DateTimeInterface | $now |
Références $now, Token\claims(), et RegisteredClaims\ISSUED_AT.
Référencé par ValidAt\assertIssueTime().
hasBeenIssuedBy | ( | $issuers | ) |
list<string> | $issuers |
Références Token\claims(), et RegisteredClaims\ISSUER.
Référencé par IssuedBy\assert().
hasClaim | ( | $name | ) |
Returns if the claim is configured
string | $name |
Références $name, et Token\claims().
hasHeader | ( | $name | ) |
Returns if the header is configured
string | $name |
Références $name, et Token\headers().
headers | ( | ) |
Références Token\$headers.
Référencé par Token\__construct(), SignedWith\assert(), Token\getHeader(), Token\getHeaders(), Token\hasHeader(), Token\payload(), Token\toString(), et Token\verify().
isExpired | ( | DateTimeInterface | $now = null | ) |
Determine if the token is expired.
DateTimeInterface | null | $now | Defaults to the current time. |
Références $now, Token\claims(), RegisteredClaims\EXPIRATION_TIME, et null.
Référencé par ValidAt\assertExpiration().
isIdentifiedBy | ( | $id | ) |
string | $id |
Références $id, Token\claims(), et RegisteredClaims\ID.
Référencé par IdentifiedBy\assert().
isMinimumTimeBefore | ( | DateTimeInterface | $now | ) |
DateTimeInterface | $now |
Références Token\claims(), et RegisteredClaims\NOT_BEFORE.
Référencé par ValidAt\assertMinimumTime().
isPermittedFor | ( | $audience | ) |
string | $audience |
Références RegisteredClaims\AUDIENCE, et Token\claims().
Référencé par PermittedFor\assert().
isRelatedTo | ( | $subject | ) |
string | $subject |
Références $subject, Token\claims(), et RegisteredClaims\SUBJECT.
Référencé par RelatedTo\assert().
payload | ( | ) |
Returns the token payload
Références Token\claims(), et Token\headers().
Référencé par Token\getPayload().
signature | ( | ) |
Références Token\$signature.
Référencé par Token\__construct(), SignedWith\assert(), Token\toString(), et Token\verify().
toString | ( | ) |
Références Token\claims(), Token\headers(), et Token\signature().
Référencé par Token\__toString().
validate | ( | ValidationData | $data | ) |
Validates if the token is valid
ValidationData | $data |
Références $data, et Token\getValidatableClaims().
verify | ( | Signer | $signer, |
$key | |||
) |
Verify if the key matches with the one that created the signature
Signer | $signer | |
Key | string | $key |
Références $key, Signer\getAlgorithmId(), Token\getPayload(), Token\headers(), et Token\signature().
|
private |
Référencé par Token\__construct().
|
private |
Référencé par Token\__construct(), et Token\claims().
|
private |
Référencé par Token\__construct(), et Token\headers().
|
private |
Référencé par Token\__construct(), et Token\signature().