ISignedRequest
in
model that store data related to a possible signature.
those details will be used:
- to confirm authenticity of a signed incoming request
- to sign an outgoing request
This interface must not be implemented in your application:
Tags
Attributes
- #[Consumable]
- $since: '33.0.0'
Table of Contents
Methods
- getBody() : string
- payload of the request
- getDigest() : string
- checksum of the payload of the request
- getDigestAlgorithm() : DigestAlgorithm
- get algorithm used to generate digest
- getSignatory() : Signatory
- get the signatory, containing keys and details, related to this request
- getSignature() : string
- get the signed version of the signature
- getSignatureData() : array<string|int, mixed>
- returns data used to generate signature
- getSigningElement() : string
- getSigningElements() : array<string|int, mixed>
- get the list of elements in the Signature header of the request
- hasSignatory() : bool
- returns if a signatory related to this request have been found and defined
- setSignatory() : self
- set the signatory, containing keys and details, related to this request
- setSigningElements() : self
- set the list of headers related to the signature of the request
Methods
getBody()
payload of the request
public
getBody() : string
Tags
Return values
stringgetDigest()
checksum of the payload of the request
public
getDigest() : string
Tags
Return values
stringgetDigestAlgorithm()
get algorithm used to generate digest
public
getDigestAlgorithm() : DigestAlgorithm
Tags
Return values
DigestAlgorithmgetSignatory()
get the signatory, containing keys and details, related to this request
public
getSignatory() : Signatory
Tags
Return values
SignatorygetSignature()
get the signed version of the signature
public
getSignature() : string
Tags
Return values
stringgetSignatureData()
returns data used to generate signature
public
getSignatureData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getSigningElement()
public
getSigningElement(string $key) : string
Parameters
- $key : string
Tags
Return values
stringgetSigningElements()
get the list of elements in the Signature header of the request
public
getSigningElements() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>hasSignatory()
returns if a signatory related to this request have been found and defined
public
hasSignatory() : bool
Tags
Return values
boolsetSignatory()
set the signatory, containing keys and details, related to this request
public
setSignatory(Signatory $signatory) : self
Parameters
- $signatory : Signatory
Tags
Return values
selfsetSigningElements()
set the list of headers related to the signature of the request
public
setSigningElements(array<string|int, mixed> $elements) : self
Parameters
- $elements : array<string|int, mixed>