JSONGeneralSerializer
extends Serializer
in package
FinalYes
Table of Contents
Constants
- NAME = 'jws_json_general'
Methods
- displayName() : string
- name() : string
- The name of the serialization.
- serialize() : string
- Converts a JWS into a string.
- unserialize() : JWS
- Loads data and return a JWS object.
- isPayloadEncoded() : bool
- checkPayloadEncoding() : void
- processHeaders() : array<string|int, mixed>
- processIsPayloadEncoded() : bool
- processPayload() : string|null
Constants
NAME
public
mixed
NAME
= 'jws_json_general'
Methods
displayName()
public
displayName() : string
Return values
stringname()
The name of the serialization.
public
name() : string
Return values
stringserialize()
Converts a JWS into a string.
public
serialize(JWS $jws[, int|null $signatureIndex = null ]) : string
Parameters
- $jws : JWS
- $signatureIndex : int|null = null
Tags
Return values
stringunserialize()
Loads data and return a JWS object.
public
unserialize(string $input) : JWS
Parameters
- $input : string
-
A string that represents a JWS
Tags
Return values
JWSisPayloadEncoded()
protected
isPayloadEncoded(array<string|int, mixed> $protectedHeader) : bool
Parameters
- $protectedHeader : array<string|int, mixed>
Return values
boolcheckPayloadEncoding()
private
checkPayloadEncoding(JWS $jws) : void
Parameters
- $jws : JWS
processHeaders()
private
processHeaders(array<string|int, mixed> $signature) : array<string|int, mixed>
Parameters
- $signature : array<string|int, mixed>
Return values
array<string|int, mixed>processIsPayloadEncoded()
private
processIsPayloadEncoded(bool|null $isPayloadEncoded, array<string|int, mixed> $protectedHeader) : bool
Parameters
- $isPayloadEncoded : bool|null
- $protectedHeader : array<string|int, mixed>
Tags
Return values
boolprocessPayload()
private
processPayload(string|null $rawPayload, bool|null $isPayloadEncoded) : string|null
Parameters
- $rawPayload : string|null
- $isPayloadEncoded : bool|null