class Error extends Message (View source)

An object representation of a generic error. Subclass this to create more specific errors if necessary.

Constants

SEVERITY_NOTICE

SEVERITY_WARNING

SEVERITY_ERROR

SEVERITY_OK

Properties

protected string $message

The error message, could also be a key for translation.

from  Message
protected string $title

An optional title for the message (used eg. in flashMessages).

from  Message
protected int $code

The error code.

from  Message
protected array $arguments

The message arguments. Will be replaced in the message body.

from  Message
protected string $severity

The severity of this message ('Error').

Methods

__construct(string $message, int|null $code = null, array $arguments = [], string $title = '')

Constructs this error

from  Message
string
getMessage()

Returns the error message

from  Message
bool
hasCode()

No description

from  Message
int
getCode()

Returns the error code

from  Message
array
getArguments()

No description

from  Message
bool
hasTitle()

No description

from  Message
string
getTitle()

No description

from  Message
string
getSeverity()

No description

from  Message
string
render()

No description

from  Message
string
__toString()

Converts this error into a string

from  Message

Details

__construct(string $message, int|null $code = null, array $arguments = [], string $title = '')

Constructs this error

Parameters

string $message

An english error message which is used if no other error message can be resolved

int|null $code

A unique error code

array $arguments

Array of arguments to be replaced in message

string $title

optional title for the message

string getMessage()

Returns the error message

Return Value

string

The error message

bool hasCode()

No description

Return Value

bool

int getCode()

Returns the error code

Return Value

int

The error code

array getArguments()

No description

Return Value

array

bool hasTitle()

No description

Return Value

bool

string getTitle()

No description

Return Value

string

string getSeverity()

No description

Return Value

string

string render()

No description

Return Value

string

string __toString()

Converts this error into a string

Return Value

string