[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/lcobucci/jwt/src/ -> Builder.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: 592 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Builder:: (30 methods):
  __construct()
  canOnlyBeUsedBy()
  permittedFor()
  setAudience()
  expiresAt()
  convertToDate()
  setExpiration()
  identifiedBy()
  setId()
  issuedAt()
  setIssuedAt()
  issuedBy()
  setIssuer()
  canOnlyBeUsedAfter()
  setNotBefore()
  relatedTo()
  setSubject()
  setRegisteredClaim()
  withHeader()
  setHeader()
  with()
  configureClaim()
  withClaim()
  forwardCallToCorrectClaimMethod()
  set()
  sign()
  unsign()
  getToken()
  convertItems()
  createSignature()


Class: Builder  - X-Ref

This class makes easier the token creation process

__construct(Encoder $encoder = null,ClaimFactory $claimFactory = null)   X-Ref
Initializes a new builder

param: Encoder $encoder
param: ClaimFactory $claimFactory

canOnlyBeUsedBy($audience, $replicateAsHeader = false)   X-Ref
Configures the audience

param: string $audience
param: bool $replicateAsHeader
return: Builder

permittedFor(...$audiences)   X-Ref
Configures the audience

param: list<string|bool> $audiences A list of audiences and, optionally, the instruction to replicate as header
return: Builder

setAudience($audience, $replicateAsHeader = false)   X-Ref
Configures the audience

param: string $audience
param: boolean $replicateAsHeader
return: Builder

expiresAt($expiration, $replicateAsHeader = false)   X-Ref
Configures the expiration time

param: int|DateTimeImmutable $expiration
param: boolean $replicateAsHeader
return: Builder

convertToDate($value)   X-Ref

param: int|DateTimeImmutable $value
return: DateTimeImmutable

setExpiration($expiration, $replicateAsHeader = false)   X-Ref
Configures the expiration time

param: int|DateTimeImmutable $expiration
param: boolean $replicateAsHeader
return: Builder

identifiedBy($id, $replicateAsHeader = false)   X-Ref
Configures the token id

param: string $id
param: boolean $replicateAsHeader
return: Builder

setId($id, $replicateAsHeader = false)   X-Ref
Configures the token id

param: string $id
param: boolean $replicateAsHeader
return: Builder

issuedAt($issuedAt, $replicateAsHeader = false)   X-Ref
Configures the time that the token was issued

param: int|DateTimeImmutable $issuedAt
param: boolean $replicateAsHeader
return: Builder

setIssuedAt($issuedAt, $replicateAsHeader = false)   X-Ref
Configures the time that the token was issued

param: int|DateTimeImmutable $issuedAt
param: boolean $replicateAsHeader
return: Builder

issuedBy($issuer, $replicateAsHeader = false)   X-Ref
Configures the issuer

param: string $issuer
param: boolean $replicateAsHeader
return: Builder

setIssuer($issuer, $replicateAsHeader = false)   X-Ref
Configures the issuer

param: string $issuer
param: boolean $replicateAsHeader
return: Builder

canOnlyBeUsedAfter($notBefore, $replicateAsHeader = false)   X-Ref
Configures the time before which the token cannot be accepted

param: int|DateTimeImmutable $notBefore
param: boolean $replicateAsHeader
return: Builder

setNotBefore($notBefore, $replicateAsHeader = false)   X-Ref
Configures the time before which the token cannot be accepted

param: int|DateTimeImmutable $notBefore
param: boolean $replicateAsHeader
return: Builder

relatedTo($subject, $replicateAsHeader = false)   X-Ref
Configures the subject

param: string $subject
param: boolean $replicateAsHeader
return: Builder

setSubject($subject, $replicateAsHeader = false)   X-Ref
Configures the subject

param: string $subject
param: boolean $replicateAsHeader
return: Builder

setRegisteredClaim($name, $value, $replicate)   X-Ref
Configures a registered claim

param: string $name
param: mixed $value
param: boolean $replicate
return: Builder

withHeader($name, $value)   X-Ref
Configures a header item

param: string $name
param: mixed $value
return: Builder

setHeader($name, $value)   X-Ref
Configures a header item

param: string $name
param: mixed $value
return: Builder

with($name, $value)   X-Ref
Configures a claim item

param: string $name
param: mixed $value
return: Builder

configureClaim($name, $value)   X-Ref

param: string $name
param: mixed $value
return: Builder

withClaim($name, $value)   X-Ref
Configures a claim item

param: string $name
param: mixed $value
return: Builder

forwardCallToCorrectClaimMethod($name, $value)   X-Ref
No description

set($name, $value)   X-Ref
Configures a claim item

param: string $name
param: mixed $value
return: Builder

sign(Signer $signer, $key)   X-Ref
Signs the data

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

unsign()   X-Ref
Removes the signature from the builder

return: Builder

getToken(Signer $signer = null, Key $key = null)   X-Ref
Returns the resultant token

return: Token

convertItems(array $items)   X-Ref

param: array<string, mixed> $items
return: array<string, mixed>

createSignature($payload, Signer $signer = null, Key $key = null)   X-Ref

param: string $payload
return: Signature



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