phpDocumentor

JsonWebToken
in package

Class JsonWebToken

Table of Contents

$headers  : array<string|int, mixed>
$includeSecretInSignaturePayload  : bool
$payload  : array<string|int, mixed>
$secret  : string
$useRawHmacForSignature  : bool
__toString()  : string
asString()  : string
createCompatibilityToken()  : JsonWebToken
createToken()  : JsonWebToken
getSignature()  : string
headers()  : array<string|int, mixed>
payload()  : array<string|int, mixed>
__construct()  : mixed
JsonWebToken constructor.
base64UrlEncode()  : string
getHeaderString()  : string
getPayloadString()  : string

Properties

$includeSecretInSignaturePayload

private bool $includeSecretInSignaturePayload

$useRawHmacForSignature

private bool $useRawHmacForSignature

Methods

__toString()

public __toString() : string
Return values
string —

asString()

public asString() : string
Return values
string —

createCompatibilityToken()

public static createCompatibilityToken(string $secret, array<string|int, mixed> $headers, array<string|int, mixed> $payload) : JsonWebToken
Parameters
$secret : string
$headers : array<string|int, mixed>
$payload : array<string|int, mixed>
Tags
deprecated

Should only be used for compatibility use cases. Primary use getJsonWebToken method.

Return values
JsonWebToken —

createToken()

public static createToken(string $secret, array<string|int, mixed> $headers, array<string|int, mixed> $payload) : JsonWebToken
Parameters
$secret : string
$headers : array<string|int, mixed>
$payload : array<string|int, mixed>
Return values
JsonWebToken —

getSignature()

public getSignature() : string
Return values
string —

headers()

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

payload()

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

__construct()

JsonWebToken constructor.

private __construct(string $secret, array<string|int, mixed> $headers, array<string|int, mixed> $payload[, bool $includeSecretInSignaturePayload = false ][, bool $useRawHmacForSignature = true ]) : mixed
Parameters
$secret : string
$headers : array<string|int, mixed>
$payload : array<string|int, mixed>
$includeSecretInSignaturePayload : bool = false
$useRawHmacForSignature : bool = true
Return values
mixed —

base64UrlEncode()

private base64UrlEncode( $input) : string
Parameters
$input :
Return values
string —

getHeaderString()

private getHeaderString() : string
Return values
string —

getPayloadString()

private getPayloadString() : string
Return values
string —

Search results