Documentation

ForbiddenException extends Exception
in package

Class ForbiddenException

Indicates 'Forbidden' response

Table of Contents

$data  : stdClass
$description  : string
__construct()  : void
Constructor
__toString()  : string
Exports exception code & message when casting to string
getDescription()  : string
Exports detailed exception description
getStatus()  : string
Exports HTTP status

Properties

$description

public string $description = ''

Methods

__construct()

Constructor

public __construct(string $message, int $code[, string $description = '' ], stdClass $data[, Throwable $previous = null ]) : void
Parameters
$message : string

Exception message

$code : int

Exception code

$description : string = ''

Detailed exception description

$data : stdClass

Response body as JSON object

$previous : Throwable = null

Previous exception (if nested)

Return values
void

__toString()

Exports exception code & message when casting to string

public __toString() : string
Return values
string

getDescription()

Exports detailed exception description

public getDescription() : string
Return values
string

getStatus()

Exports HTTP status

public getStatus() : string
Return values
string

Search results