HumHub Documentation (unofficial)

Signature
in package

Table of Contents

Properties

$encodedProtectedHeader  : null|string
$header  : array<string|int, mixed>
$protectedHeader  : array<string|int, mixed>
$signature  : string

Methods

__construct()  : mixed
getEncodedProtectedHeader()  : string|null
The protected header associated with the signature.
getHeader()  : array<string|int, mixed>
The unprotected header associated with the signature.
getHeaderParameter()  : null|mixed
Returns the value of the unprotected header of the specified key.
getProtectedHeader()  : array<string|int, mixed>
The protected header associated with the signature.
getProtectedHeaderParameter()  : null|mixed
Returns the value of the protected header of the specified key.
getSignature()  : string
Returns the value of the signature.
hasHeaderParameter()  : bool
Returns true if the unprotected header has the given parameter.
hasProtectedHeaderParameter()  : bool
Returns true if the protected header has the given parameter.

Properties

$encodedProtectedHeader

private null|string $encodedProtectedHeader

$header

private array<string|int, mixed> $header

$protectedHeader

private array<string|int, mixed> $protectedHeader

Methods

__construct()

public __construct(string $signature, array<string|int, mixed> $protectedHeader, string|null $encodedProtectedHeader, array<string|int, mixed> $header) : mixed
Parameters
$signature : string
$protectedHeader : array<string|int, mixed>
$encodedProtectedHeader : string|null
$header : array<string|int, mixed>

getEncodedProtectedHeader()

The protected header associated with the signature.

public getEncodedProtectedHeader() : string|null
Return values
string|null

getHeader()

The unprotected header associated with the signature.

public getHeader() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHeaderParameter()

Returns the value of the unprotected header of the specified key.

public getHeaderParameter(string $key) : null|mixed
Parameters
$key : string

The key

Return values
null|mixed —

Header value

getProtectedHeader()

The protected header associated with the signature.

public getProtectedHeader() : array<string|int, mixed>
Return values
array<string|int, mixed>

getProtectedHeaderParameter()

Returns the value of the protected header of the specified key.

public getProtectedHeaderParameter(string $key) : null|mixed
Parameters
$key : string

The key

Tags
throws
InvalidArgumentException

if the header parameter does not exist

Return values
null|mixed —

Header value

getSignature()

Returns the value of the signature.

public getSignature() : string
Return values
string

hasHeaderParameter()

Returns true if the unprotected header has the given parameter.

public hasHeaderParameter(string $key) : bool
Parameters
$key : string

The key

Return values
bool

hasProtectedHeaderParameter()

Returns true if the protected header has the given parameter.

public hasProtectedHeaderParameter(string $key) : bool
Parameters
$key : string

The key

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results