class SanitizerException extends UserMessageException (View source)

Constants

ERROR_FAILED_TO_READ_FILE

Error code: failed to read the file.

ERROR_FAILED_TO_WRITE_FILE

Error code: failed to write the file.

ERROR_FAILED_TO_PARSE_XML

Error code: failed to parse the XML.

ERROR_FAILED_TO_GENERATE_XML

Error code: failed to generate the XML.

Properties

protected bool $canBeLogged

Can this exception be added to the log?

from  UserMessageException
private bool Since: concrete5 8.5.0a3
$messageContainsHtml

Does the message contain an HTML-formatted string?

from  UserMessageException

Methods

bool
canBeLogged()

Can this exception be added to the log?

$this
setCanBeLogged(bool $value)

Can this exception be added to the log?

bool
messageContainsHtml()

Does the message contain an HTML-formatted string?

$this
setMessageContainsHtml(bool $value)

Does the message contain an HTML-formatted string?

jsonSerialize()

{@inheritdoc}

create(int $errorCode, string $customErrorMessage = '')

No description

Details

bool canBeLogged()

Can this exception be added to the log?

Return Value

bool

$this setCanBeLogged(bool $value)

Can this exception be added to the log?

Parameters

bool $value

Return Value

$this

bool messageContainsHtml()

Since: concrete5 8.5.0a3

Does the message contain an HTML-formatted string?

$this setMessageContainsHtml(bool $value)

Since: concrete5 8.5.0a3

Does the message contain an HTML-formatted string?

Parameters

bool $value

Return Value

$this

jsonSerialize()

{@inheritdoc}

See also

\JsonSerializable::jsonSerialize()

static SanitizerException create(int $errorCode, string $customErrorMessage = '')

No description

Parameters

int $errorCode

one of the ERROR_... constants

string $customErrorMessage

A custom error message

Return Value

SanitizerException