Documentation

ReportError
in package

Read onlyYes
FinalYes

Canonical error data used when no command-specific result document exists.

Table of Contents

Constants

KIND_ERROR  : mixed = 'error'
KIND_FAILURE  : mixed = 'failure'

Methods

__construct()  : mixed
error()  : self
failure()  : self
fromThrowable()  : self
getDetails()  : string
getKind()  : string
getMessage()  : string
getType()  : string

Constants

Methods

__construct()

public __construct(string $kind, string $type, string $message[, string $details = '' ]) : mixed
Parameters
$kind : string
$type : string
$message : string
$details : string = ''

error()

public static error(string $type, string $message[, string $details = '' ]) : self
Parameters
$type : string
$message : string
$details : string = ''
Return values
self

failure()

public static failure(string $type, string $message[, string $details = '' ]) : self
Parameters
$type : string
$message : string
$details : string = ''
Return values
self

fromThrowable()

public static fromThrowable(Throwable $error[, string $kind = self::KIND_ERROR ]) : self
Parameters
$error : Throwable
$kind : string = self::KIND_ERROR
Return values
self

getDetails()

public getDetails() : string
Return values
string

getKind()

public getKind() : string
Return values
string

getMessage()

public getMessage() : string
Return values
string

getType()

public getType() : string
Return values
string
On this page

Search results