ApiOpenStudio PHPDoc

ApiException extends Exception
in package

Class ApiException

Custom Exception handler for ApiOpenStudio.

Table of Contents

$htmlCode  : int
HTML response code.
$processor  : mixed
Processor ID.
__construct()  : mixed
Throw an API exception. This will return a standard error object in the format requested in the header.
getHtmlCode()  : int
Get the HTML return code.
getProcessor()  : mixed
Get the ID of the processor.

Properties

$htmlCode

HTML response code.

private int $htmlCode

HTML response code.

Methods

__construct()

Throw an API exception. This will return a standard error object in the format requested in the header.

public __construct([string|null $message = null ][, int|null $code = null ][, mixed $processor = -1 ][, int|null $htmlCode = null ][, Exception|null $previous = null ]) : mixed
Parameters
$message : string|null = null

The Exception message to throw.

$code : int|null = null

The Exception code.

$processor : mixed = -1

The processor where the error occurred.

$htmlCode : int|null = null

The HTML return code.

$previous : Exception|null = null

The previous exception used for the exception chaining. Since 5.3.0.

Return values
mixed

getHtmlCode()

Get the HTML return code.

public getHtmlCode() : int
Return values
int

Get the HTML return code.

getProcessor()

Get the ID of the processor.

public getProcessor() : mixed
Return values
mixed

Get the processor where the error occurred.

Search results