[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/lcobucci/jwt/src/ -> Token.php (summary)

This file is part of Lcobucci\JWT, a simple library to handle JWT and JWS

License: http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
File Size: 430 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Token:: (25 methods):
  __construct()
  convertToDataSet()
  headers()
  getHeaders()
  hasHeader()
  getHeader()
  claims()
  getClaims()
  hasClaim()
  getClaim()
  verify()
  validate()
  isExpired()
  isPermittedFor()
  isIdentifiedBy()
  isRelatedTo()
  hasBeenIssuedBy()
  hasBeenIssuedBefore()
  isMinimumTimeBefore()
  getValidatableClaims()
  getPayload()
  payload()
  signature()
  __toString()
  toString()


Class: Token  - X-Ref

Basic structure of the JWT

__construct($headers = ['alg' => 'none'],$claims = [],Signature $signature = null,array $payload = ['', ''],Factory $claimFactory = null)   X-Ref
Initializes the object

param: array|DataSet $headers
param: array|DataSet $claims
param: Signature|null $signature
param: array $payload
param: Factory|null $claimFactory

convertToDataSet($data, $payload)   X-Ref

param: array|DataSet $data
param: string $payload

headers()   X-Ref
No description

getHeaders()   X-Ref
Returns the token headers

return: array

hasHeader($name)   X-Ref
Returns if the header is configured

param: string $name
return: boolean

getHeader($name, $default = null)   X-Ref
Returns the value of a token header

param: string $name
param: mixed $default
return: mixed

claims()   X-Ref
No description

getClaims()   X-Ref
Returns the token claim set

return: array

hasClaim($name)   X-Ref
Returns if the claim is configured

param: string $name
return: boolean

getClaim($name, $default = null)   X-Ref
Returns the value of a token claim

param: string $name
param: mixed $default
return: mixed

verify(Signer $signer, $key)   X-Ref
Verify if the key matches with the one that created the signature

param: Signer $signer
param: Key|string $key
return: boolean

validate(ValidationData $data)   X-Ref
Validates if the token is valid

param: ValidationData $data
return: boolean

isExpired(DateTimeInterface $now = null)   X-Ref
Determine if the token is expired.

param: DateTimeInterface|null $now Defaults to the current time.
return: bool

isPermittedFor($audience)   X-Ref

param: string $audience
return: bool

isIdentifiedBy($id)   X-Ref

param: string $id
return: bool

isRelatedTo($subject)   X-Ref

param: string $subject
return: bool

hasBeenIssuedBy(...$issuers)   X-Ref

param: list<string> $issuers
return: bool

hasBeenIssuedBefore(DateTimeInterface $now)   X-Ref

param: DateTimeInterface $now
return: bool

isMinimumTimeBefore(DateTimeInterface $now)   X-Ref

param: DateTimeInterface $now
return: bool

getValidatableClaims()   X-Ref
Yields the validatable claims

return: Generator

getPayload()   X-Ref
Returns the token payload

return: string

payload()   X-Ref
Returns the token payload

return: string

signature()   X-Ref
No description

__toString()   X-Ref
Returns an encoded representation of the token

return: string

toString()   X-Ref
No description



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer