HintException
extends Exception
in package
Class HintException
An Exception class with the intention to be presented to the end user
Tags
Table of Contents
Properties
- $hint : mixed
Methods
- __construct() : mixed
- HintException constructor.
- __toString() : string
- Returns a string representation of this Exception that includes the error code, the message and the hint.
- getHint() : string
- Returns the hint with the intention to be presented to the end user. If an empty hint was specified upon instantiation, the message is returned instead.
Properties
$hint
private
mixed
$hint
Methods
__construct()
HintException constructor.
public
__construct(string $message[, string $hint = '' ][, int $code = 0 ][, Exception|null $previous = null ]) : mixed
Parameters
- $message : string
-
The error message. It will be not revealed to the the user (unless the hint is empty) and thus should be not translated.
- $hint : string = ''
-
A useful message that is presented to the end user. It should be translated, but must not contain sensitive data.
- $code : int = 0
- $previous : Exception|null = null
Tags
__toString()
Returns a string representation of this Exception that includes the error code, the message and the hint.
public
__toString() : string
Tags
Return values
stringgetHint()
Returns the hint with the intention to be presented to the end user. If an empty hint was specified upon instantiation, the message is returned instead.
public
getHint() : string