Référence de la classe JWS

Graphe d'héritage de JWS:

Fonctions membres publiques
	__construct (?string $payload, ?string $encodedPayload=null, bool $isPayloadDetached=false)
	getPayload ()
	isPayloadDetached ()
	getEncodedPayload ()
	getSignatures ()
	getSignature (int $id)
	addSignature (string $signature, array $protectedHeader, ?string $encodedProtectedHeader, array $header=[])
	countSignatures ()
	split ()

Attributs privés
	$isPayloadDetached = false
	$encodedPayload
	$signatures = []
	$payload

Documentation des constructeurs et destructeur

__construct()

__construct	(	?string	$payload,
		?string	$encodedPayload = null,
		bool	$isPayloadDetached = false
	)

Références JWS\$encodedPayload, JWS\$isPayloadDetached, JWS\$payload, et JWS\isPayloadDetached().

Documentation des fonctions membres

addSignature()

addSignature	(	string	$signature,
		array	$protectedHeader,
		?string	$encodedProtectedHeader,
		array	$header = []
	)

This method adds a signature to the JWS object. Its returns a new JWS object.

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

countSignatures()

countSignatures

(

)

Returns the number of signature associated with the JWS.

Référencé par JWSLoader\loadAndVerifyWithKeySet(), JSONGeneralSerializer\serialize(), et JWSVerifier\verifyWithKeySet().

getEncodedPayload()

getEncodedPayload

(

)

Returns the Base64Url encoded payload. If the payload is detached, this method returns null.

Références JWS\$encodedPayload, JWS\isPayloadDetached(), et null.

Référencé par JWSVerifier\getInputToVerify(), JSONFlattenedSerializer\serialize(), CompactSerializer\serialize(), et JSONGeneralSerializer\serialize().

getPayload()

getPayload

(

)

Returns the payload of the JWT. null is a valid payload (e.g. JWS with detached payload).

Implémente JWT.

Références JWS\$payload.

Référencé par JWSVerifier\checkPayload(), JWSVerifier\getInputToVerify(), et CompactSerializer\serialize().

getSignature()

getSignature

(

int

$id

)

Returns the signature at the given index.

Exceptions

InvalidArgumentException

if the signature index does not exist

Références $id.

Référencé par JSONFlattenedSerializer\serialize(), CompactSerializer\serialize(), et JWSVerifier\verifyWithKeySet().

getSignatures()

getSignatures

(

)

Returns the signatures associated with the JWS.

Renvoie

Signature[]

Références JWS\$signatures.

Référencé par JSONGeneralSerializer\checkPayloadEncoding(), et JSONGeneralSerializer\serialize().

isPayloadDetached()

isPayloadDetached

(

)

Returns true if the payload is detached.

Références JWS\$isPayloadDetached.

Référencé par JWS\__construct(), JSONGeneralSerializer\checkPayloadEncoding(), JWS\getEncodedPayload(), et JSONGeneralSerializer\serialize().

split()

split

(

)

This method splits the JWS into a list of JWSs. It is only useful when the JWS contains more than one signature (JSON General Serialization).

Renvoie

JWS[]

Références JWS\$encodedPayload, JWS\$isPayloadDetached, JWS\$payload, et $result.

Documentation des champs

$encodedPayload

$encodedPayload

private

Référencé par JWS\__construct(), JWS\getEncodedPayload(), et JWS\split().

$isPayloadDetached

$isPayloadDetached = false

private

Référencé par JWS\__construct(), JWS\isPayloadDetached(), et JWS\split().

$payload

$payload

private

Référencé par JWS\__construct(), JWS\getPayload(), et JWS\split().

$signatures

$signatures = []

private

Référencé par JWS\getSignatures().

---

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

• JWS.php