Abstract Class yii\base\ErrorHandler
| Inheritance | yii\base\ErrorHandler » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\console\ErrorHandler, yii\web\ErrorHandler |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/base/ErrorHandler.php |
ErrorHandler handles uncaught PHP errors and exceptions.
ErrorHandler is configured as an application component in yii\base\Application by default.
You can access that instance via Yii::$app->errorHandler.
For more details and usage information on ErrorHandler, see the guide article on handling errors.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
| $discardExistingOutput | boolean | Whether to discard any existing page output before error display. | yii\base\ErrorHandler |
| $exception | Exception|null | The exception that is being handled currently. | yii\base\ErrorHandler |
| $memoryReserveSize | integer | The size of the reserved memory. | yii\base\ErrorHandler |
| $silentExitOnException | boolean | If true - handleException() will finish script with ExitCode::OK. |
yii\base\ErrorHandler |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| clearOutput() | Removes all output echoed before calling this method. | yii\base\ErrorHandler |
| convertExceptionToError() | Converts an exception into a PHP error. | yii\base\ErrorHandler |
| convertExceptionToString() | Converts an exception into a simple string. | yii\base\ErrorHandler |
| convertExceptionToVerboseString() | Converts an exception into a string that has verbose information about the exception and its trace. | yii\base\ErrorHandler |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| handleError() | Handles PHP execution errors such as warnings and notices. | yii\base\ErrorHandler |
| handleException() | Handles uncaught PHP exceptions. | yii\base\ErrorHandler |
| handleFatalError() | Handles fatal PHP errors. | yii\base\ErrorHandler |
| handleHhvmError() | Handles HHVM execution errors such as warnings and notices. | yii\base\ErrorHandler |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | yii\base\ErrorHandler | |
| logException() | Logs the given exception. | yii\base\ErrorHandler |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| register() | Register this error handler. | yii\base\ErrorHandler |
| trigger() | Triggers an event. | yii\base\Component |
| unregister() | Unregisters this error handler by restoring the PHP error and exception handlers. | yii\base\ErrorHandler |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| handleFallbackExceptionMessage() | Handles exception thrown during exception processing in handleException(). | yii\base\ErrorHandler |
| renderException() | Renders the exception. | yii\base\ErrorHandler |
Property Details
Whether to discard any existing page output before error display. Defaults to true.
The exception that is being handled currently.
The size of the reserved memory. A portion of memory is pre-allocated so that when an out-of-memory issue occurs, the error handler is able to handle the error with the help of this reserved memory. If you set this value to be 0, no memory will be reserved. Defaults to 256KB.
If true - handleException() will finish script with ExitCode::OK.
false - ExitCode::UNSPECIFIED_ERROR.
Method Details
Removes all output echoed before calling this method.
| public void clearOutput ( ) |
Converts an exception into a PHP error.
This method can be used to convert exceptions inside of methods like __toString()
to PHP errors because exceptions cannot be thrown inside of them.
| public static void convertExceptionToError ( $exception ) | ||
| $exception | Exception|\Throwable | The exception to convert to a PHP error. |
Converts an exception into a simple string.
| public static string convertExceptionToString ( $exception ) | ||
| $exception | Exception|\Error|\Throwable | The exception being converted |
| return | string | The string representation of the exception. |
|---|---|---|
Converts an exception into a string that has verbose information about the exception and its trace.
| public static string convertExceptionToVerboseString ( $exception ) | ||
| $exception | Exception|\Error|\Throwable | The exception being converted |
| return | string | The string representation of the exception. |
|---|---|---|
Handles PHP execution errors such as warnings and notices.
This method is used as a PHP error handler. It will simply raise an yii\base\ErrorException.
| public boolean handleError ( $code, $message, $file, $line ) | ||
| $code | integer | The level of the error raised. |
| $message | string | The error message. |
| $file | string | The filename that the error was raised in. |
| $line | integer | The line number the error was raised at. |
| return | boolean | Whether the normal error handler continues. |
|---|---|---|
| throws | yii\base\ErrorException | |
Handles uncaught PHP exceptions.
This method is implemented as a PHP exception handler.
| public void handleException ( $exception ) | ||
| $exception | Exception | The exception that is not caught |
Handles exception thrown during exception processing in handleException().
| protected void handleFallbackExceptionMessage ( $exception, $previousException ) | ||
| $exception | Exception|\Throwable | Exception that was thrown during main exception processing. |
| $previousException | Exception | Main exception processed in handleException(). |
Handles fatal PHP errors.
| public void handleFatalError ( ) |
Handles HHVM execution errors such as warnings and notices.
This method is used as a HHVM error handler. It will store exception that will be used in fatal error handler
| public boolean handleHhvmError ( $code, $message, $file, $line, $context, $backtrace ) | ||
| $code | integer | The level of the error raised. |
| $message | string | The error message. |
| $file | string | The filename that the error was raised in. |
| $line | integer | The line number the error was raised at. |
| $context | mixed | |
| $backtrace | mixed | Trace of error |
| return | boolean | Whether the normal error handler continues. |
|---|---|---|
| throws | yii\base\ErrorException | |
| public void init ( ) |
Logs the given exception.
| public void logException ( $exception ) | ||
| $exception | Exception | The exception to be logged |
Register this error handler.
| public void register ( ) |
Renders the exception.
| protected abstract void renderException ( $exception ) | ||
| $exception | Exception|\Error|\Throwable | The exception to be rendered. |
Unregisters this error handler by restoring the PHP error and exception handlers.
| public void unregister ( ) |