# ErrorHandler

> ErrorHandler handles uncaught PHP errors and exceptions.

[API reference](/docs/api/index.md) › [yii](/docs/api/yii/index.md) › [console](/docs/api/yii/console/index.md) › ErrorHandler

| class | `yii\console\ErrorHandler` |
| --- | --- |
| Extends | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) » [`yii\base\Component`](/docs/api/yii/base/component/index.md) » [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| Implements | [`yii\base\Configurable`](/docs/api/yii/base/configurable/index.md) |
| Since | 2.0 |
| Source | [`framework/console/ErrorHandler.php`](https://github.com/yiisoft/yii2/blob/22.0/framework/console/ErrorHandler.php#L25) |

ErrorHandler handles uncaught PHP errors and exceptions.

ErrorHandler is configured as an application component in [`Application`](/docs/api/yii/base/application/index.md) by default.
You can access that instance via `Yii::$app->errorHandler`.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-behaviors"></span>[`$behaviors`](/docs/api/yii/base/component/index.md#property-behaviors) read-only | `array<`[`yii\base\Behavior`](/docs/api/yii/base/behavior/index.md)`<static>>` | List of behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="property-discardExistingOutput"></span>[`$discardExistingOutput`](/docs/api/yii/base/errorhandler/index.md#property-discardExistingOutput) | `bool` | Whether to discard any existing page output before error display. Default: `true`. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="property-exception"></span>[`$exception`](/docs/api/yii/base/errorhandler/index.md#property-exception) | [`Throwable`](https://www.php.net/manual/en/class.throwable.php)`\|null` | The exception that is being handled currently. Default: `null`. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="property-memoryReserveSize"></span>[`$memoryReserveSize`](/docs/api/yii/base/errorhandler/index.md#property-memoryReserveSize) | `int` | The size of the reserved memory. Default: `262144`. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="property-silentExitOnException"></span>[`$silentExitOnException`](/docs/api/yii/base/errorhandler/index.md#property-silentExitOnException) | `bool` | If true - `handleException()` will finish script with `ExitCode::OK`. false - `ExitCode::UNSPECIFIED_ERROR`. Default: `null`. Available since 2.0.36. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/api/yii/base/baseobject/index.md#method-__construct) | Constructor. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-__call"></span>[`__call()`](/docs/api/yii/base/component/index.md#method-__call) | Calls the named method which is not a class method. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__clone"></span>[`__clone()`](/docs/api/yii/base/component/index.md#method-__clone) | This method is called after the object is created by cloning an existing one. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__get"></span>[`__get()`](/docs/api/yii/base/component/index.md#method-__get) | Returns the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__isset"></span>[`__isset()`](/docs/api/yii/base/component/index.md#method-__isset) | Checks if a property is set, i.e. defined and not null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__set"></span>[`__set()`](/docs/api/yii/base/component/index.md#method-__set) | Sets the value of a component property. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-__unset"></span>[`__unset()`](/docs/api/yii/base/component/index.md#method-__unset) | Sets a component property to be null. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehavior"></span>[`attachBehavior()`](/docs/api/yii/base/component/index.md#method-attachBehavior) | Attaches a behavior to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-attachBehaviors"></span>[`attachBehaviors()`](/docs/api/yii/base/component/index.md#method-attachBehaviors) | Attaches a list of behaviors to the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-behaviors"></span>[`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) | Returns a list of behaviors that this component should behave as. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canGetProperty"></span>[`canGetProperty()`](/docs/api/yii/base/component/index.md#method-canGetProperty) | Returns a value indicating whether a property can be read. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-canSetProperty"></span>[`canSetProperty()`](/docs/api/yii/base/component/index.md#method-canSetProperty) | Returns a value indicating whether a property can be set. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-className"></span>[`className()`](/docs/api/yii/base/baseobject/index.md#method-className) static | Returns the fully qualified name of this class. | [`yii\base\BaseObject`](/docs/api/yii/base/baseobject/index.md) |
| <span id="method-clearOutput"></span>[`clearOutput()`](/docs/api/yii/base/errorhandler/index.md#method-clearOutput) | Removes all output echoed before calling this method. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-convertExceptionToString"></span>[`convertExceptionToString()`](/docs/api/yii/base/errorhandler/index.md#method-convertExceptionToString) static | Converts an exception into a simple string. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-convertExceptionToVerboseString"></span>[`convertExceptionToVerboseString()`](/docs/api/yii/base/errorhandler/index.md#method-convertExceptionToVerboseString) static | Converts an exception into a string that has verbose information about the exception and its trace. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-detachBehavior"></span>[`detachBehavior()`](/docs/api/yii/base/component/index.md#method-detachBehavior) | Detaches a behavior from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-detachBehaviors"></span>[`detachBehaviors()`](/docs/api/yii/base/component/index.md#method-detachBehaviors) | Detaches all behaviors from the component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-ensureBehaviors"></span>[`ensureBehaviors()`](/docs/api/yii/base/component/index.md#method-ensureBehaviors) | Makes sure that the behaviors declared in [`behaviors()`](/docs/api/yii/base/component/index.md#method-behaviors) are attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehavior"></span>[`getBehavior()`](/docs/api/yii/base/component/index.md#method-getBehavior) | Returns the named behavior object. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-getBehaviors"></span>[`getBehaviors()`](/docs/api/yii/base/component/index.md#method-getBehaviors) | Returns all behaviors attached to this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-handleError"></span>[`handleError()`](/docs/api/yii/base/errorhandler/index.md#method-handleError) | Handles PHP execution errors such as warnings and notices. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-handleException"></span>[`handleException()`](/docs/api/yii/base/errorhandler/index.md#method-handleException) | Handles uncaught PHP exceptions. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-handleFatalError"></span>[`handleFatalError()`](/docs/api/yii/base/errorhandler/index.md#method-handleFatalError) | Handles fatal PHP errors. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-hasEventHandlers"></span>[`hasEventHandlers()`](/docs/api/yii/base/component/index.md#method-hasEventHandlers) | Returns a value indicating whether there is any handler attached to the named event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasMethod"></span>[`hasMethod()`](/docs/api/yii/base/component/index.md#method-hasMethod) | Returns a value indicating whether a method is defined. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-hasProperty"></span>[`hasProperty()`](/docs/api/yii/base/component/index.md#method-hasProperty) | Returns a value indicating whether a property is defined for this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-init"></span>[`init()`](/docs/api/yii/base/errorhandler/index.md#method-init) |  | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-logException"></span>[`logException()`](/docs/api/yii/base/errorhandler/index.md#method-logException) | Logs the given exception. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-off"></span>[`off()`](/docs/api/yii/base/component/index.md#method-off) | Detaches an existing event handler from this component. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-on"></span>[`on()`](/docs/api/yii/base/component/index.md#method-on) | Attaches an event handler to an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-register"></span>[`register()`](/docs/api/yii/base/errorhandler/index.md#method-register) | Register this error handler. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| <span id="method-trigger"></span>[`trigger()`](/docs/api/yii/base/component/index.md#method-trigger) | Triggers an event. | [`yii\base\Component`](/docs/api/yii/base/component/index.md) |
| <span id="method-unregister"></span>[`unregister()`](/docs/api/yii/base/errorhandler/index.md#method-unregister) | Unregisters this error handler by restoring the PHP error and exception handlers. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| [`formatMessage()`](#method-formatMessage) protected | Colorizes a message for console output. | `ErrorHandler` |
| <span id="method-handleFallbackExceptionMessage"></span>[`handleFallbackExceptionMessage()`](/docs/api/yii/base/errorhandler/index.md#method-handleFallbackExceptionMessage) protected | Handles exception thrown during exception processing in [`handleException()`](/docs/api/yii/base/errorhandler/index.md#method-handleException). | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |
| [`renderException()`](#method-renderException) protected | Renders an exception using ansi format for console output. | `ErrorHandler` |

## Events

| Event | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="event-EVENT_SHUTDOWN"></span>[`EVENT_SHUTDOWN`](/docs/api/yii/base/errorhandler/index.md#event-EVENT_SHUTDOWN) | [`yii\base\Event`](/docs/api/yii/base/event/index.md) | An event that is triggered when the handler is called by shutdown function via [`handleFatalError()`](/docs/api/yii/base/errorhandler/index.md#method-handleFatalError). Event name: `'shutdown'`. Available since 2.0.46. | [`yii\base\ErrorHandler`](/docs/api/yii/base/errorhandler/index.md) |

## Method details

### formatMessage() <span id="method-formatMessage"></span>

```php
protected function formatMessage(string $message, array $format = [\yii\helpers\Console::FG_RED, \yii\helpers\Console::BOLD]): string
```

Colorizes a message for console output.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$message` | `string` | The message to colorize. |
| `$format` | `array` | The message format. |

**Returns**

`string`: The colorized message.

**See also**

- [`Console::ansiFormat()`](/docs/api/yii/helpers/baseconsole/index.md#method-ansiFormat) (for details on how to specify the message format.)

### renderException() <span id="method-renderException"></span>

```php
protected function renderException(Throwable $exception): mixed
```

Renders an exception using ansi format for console output.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$exception` | [`Throwable`](https://www.php.net/manual/en/class.throwable.php) | The exception to be rendered. |

**Returns**

`mixed`