Référence de la classe JWSBuilder

Fonctions membres publiques
	__construct (AlgorithmManager $signatureAlgorithmManager)
	getSignatureAlgorithmManager ()
	create ()
	withPayload (string $payload, bool $isPayloadDetached=false)
	addSignature (JWK $signatureKey, array $protectedHeader, array $header=[])

Attributs protégés
	$payload
	$isPayloadDetached
	$signatures = []
	$isPayloadEncoded

Fonctions membres privées
	checkIfPayloadIsEncoded (array $protectedHeader)
	checkB64AndCriticalHeader (array $protectedHeader)
	findSignatureAlgorithm (JWK $key, array $protectedHeader, array $header)
	checkDuplicatedHeaderParameters (array $header1, array $header2)

Attributs privés
	$signatureAlgorithmManager

Documentation des constructeurs et destructeur

__construct()

__construct

(

AlgorithmManager

$signatureAlgorithmManager

)

Références JWSBuilder\$signatureAlgorithmManager.

Documentation des fonctions membres

addSignature()

addSignature	(	JWK	$signatureKey,
		array	$protectedHeader,
		array	$header = []
	)

Adds the information needed to compute the signature. This method will return a new JWSBuilder object.

Exceptions

InvalidArgumentException

if the payload encoding is inconsistent

Renvoie

JWSBuilder

Références $header, JWSBuilder\$isPayloadEncoded, $this, JWSBuilder\checkB64AndCriticalHeader(), JWSBuilder\checkDuplicatedHeaderParameters(), JWSBuilder\checkIfPayloadIsEncoded(), KeyChecker\checkKeyAlgorithm(), KeyChecker\checkKeyUsage(), elseif, JWSBuilder\findSignatureAlgorithm(), et null.

checkB64AndCriticalHeader()

checkB64AndCriticalHeader ( array  $protectedHeader )

private

Exceptions

LogicException

if the header parameter "crit" is missing, invalid or does not contain "b64" when "b64" is set

Référencé par JWSBuilder\addSignature().

checkDuplicatedHeaderParameters()

checkDuplicatedHeaderParameters ( array  $header1, array  $header2  )

private

Exceptions

InvalidArgumentException

if the header contains duplicated entries

Référencé par JWSBuilder\addSignature().

checkIfPayloadIsEncoded()

checkIfPayloadIsEncoded ( array  $protectedHeader )

private

Référencé par JWSBuilder\addSignature().

create()

create

(

)

Reset the current data.

Renvoie

JWSBuilder

Références $this, et null.

Référencé par JWSBuilderFactory\create().

findSignatureAlgorithm()

findSignatureAlgorithm ( JWK  $key, array  $protectedHeader, array  $header  )

private

Exceptions

InvalidArgumentException

if the header parameter "alg" is missing or the algorithm is not allowed/not supported

Renvoie

MacAlgorithm|SignatureAlgorithm

Références $header, et $key.

Référencé par JWSBuilder\addSignature().

getSignatureAlgorithmManager()

getSignatureAlgorithmManager

(

)

Returns the algorithm manager associated to the builder.

Références JWSBuilder\$signatureAlgorithmManager.

withPayload()

withPayload	(	string	$payload,
		bool	$isPayloadDetached = false
	)

Set the payload. This method will return a new JWSBuilder object.

Exceptions

InvalidArgumentException

if the payload is not UTF-8 encoded

Renvoie

JWSBuilder

Références JWSBuilder\$isPayloadDetached, JWSBuilder\$payload, et $this.

Documentation des champs

$isPayloadDetached

$isPayloadDetached

protected

Référencé par JWSBuilder\withPayload().

$isPayloadEncoded

$isPayloadEncoded

protected

Référencé par JWSBuilder\addSignature().

$payload

$payload

protected

Référencé par JWSBuilder\withPayload().

$signatureAlgorithmManager

$signatureAlgorithmManager

private

Référencé par JWSBuilder\__construct(), et JWSBuilder\getSignatureAlgorithmManager().

$signatures

$signatures = []

protected

---

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

• JWSBuilder.php