RuntimeExceptionWithPayload
extends RuntimeException
in package
implements
WithPayload
Provides an RuntimeException with access to a JWT's payload.
Table of Contents
Interfaces
- WithPayload
- Provides a common interface to check for exception types that contain ::getPayload().
Methods
- __construct() : mixed
- convert() : RuntimeExceptionWithPayload
- Converts a normal RuntimeException to one with a payload.
- getPayload() : object
- Gets the JWT payload value.
Methods
__construct()
public
__construct(object $payload[, string $message = '' ][, int $code = 0 ][, Throwable|null $previous = null ]) : mixed
Parameters
- $payload : object
-
Data that was provided for the payload section.
- $message : string = ''
-
The Exception message to throw.
- $code : int = 0
-
The Exception code.
- $previous : Throwable|null = null
-
The previous exception used for the exception chaining.
convert()
Converts a normal RuntimeException to one with a payload.
public
static convert(object $payload, Throwable $previous) : RuntimeExceptionWithPayload
Parameters
- $payload : object
-
Data that was provided for the payload section.
- $previous : Throwable
-
Exception to convert.
Return values
RuntimeExceptionWithPayloadgetPayload()
Gets the JWT payload value.
public
getPayload() : object