Documentation

OpenStackException extends ReporterException
in package
Uses ActivityLogger

OpenStack Exception

Table of Contents

$errorLogName  : string
$warningLogName  : string
$jobsLogName  : string
The name of the log in which we are going to log actions performed by jobs
$activity  : Activity
The activity_log in which this exception has been reported
$data  : array<string|int, mixed>
$errorKey  : string
The codified error key, if exists
$httpResponseCode  : int
The HTTP Response Code to return
__construct()  : mixed
getData()  : array<string|int, mixed>
getErrorKey()  : string
getHttpResponseCode()  : int
logEntry()  : Activity
logEntryWithoutModel()  : Activity
logError()  : Activity
logWarning()  : Activity
render()  : Response
Render the exception into an HTTP response.
report()  : bool|null
Report the exception.
setActivity()  : self
Setter for the activity property
switchToWarning()  : void
Undo the logging of this error.
log()  : array<string|int, Activity>

Properties

$warningLogName

public static string $warningLogName = "warning"

$jobsLogName

The name of the log in which we are going to log actions performed by jobs

protected string $jobsLogName = "jobs"

$activity

The activity_log in which this exception has been reported

private Activity $activity

$httpResponseCode

The HTTP Response Code to return

private int $httpResponseCode

Methods

__construct()

public __construct(BadResponseError $originalException) : mixed
Parameters
$originalException : BadResponseError
Return values
mixed —

getData()

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

getHttpResponseCode()

public getHttpResponseCode() : int
Return values
int —

logEntry()

public static logEntry(Model $model, array<string|int, mixed> $properties, string $description, string $event, string $logName) : Activity
Parameters
$model : Model
$properties : array<string|int, mixed>
$description : string
$event : string
$logName : string
Return values
Activity —

logEntryWithoutModel()

public static logEntryWithoutModel(array<string|int, mixed> $properties, string $description, string $event, string $logName) : Activity
Parameters
$properties : array<string|int, mixed>
$description : string
$event : string
$logName : string
Return values
Activity —

logError()

public static logError(Model $model, array<string|int, mixed> $properties, string $description, string $event) : Activity
Parameters
$model : Model
$properties : array<string|int, mixed>
$description : string
$event : string
Return values
Activity —

logWarning()

public static logWarning(Model $model, array<string|int, mixed> $properties, string $description, string $event) : Activity
Parameters
$model : Model
$properties : array<string|int, mixed>
$description : string
$event : string
Return values
Activity —

render()

Render the exception into an HTTP response.

public render(Request $request) : Response
Parameters
$request : Request
Return values
Response —

report()

Report the exception.

public report() : bool|null
Return values
bool|null —

setActivity()

Setter for the activity property

public setActivity(Activity $activity) : self
Parameters
$activity : Activity
Return values
self —

switchToWarning()

Undo the logging of this error.

public switchToWarning() : void

This is used when this exception has been catched elsewhere

Return values
void —

log()

protected log(Model|array<string|int, mixed> $models, array<string|int, mixed> $properties, string $description[, null $logName = null ]) : array<string|int, Activity>
Parameters
$models : Model|array<string|int, mixed>
$properties : array<string|int, mixed>
$description : string
$logName : null = null
Return values
array<string|int, Activity> —

Search results