ErrorHandler

API reference › yii › console › ErrorHandler

class	`yii\console\ErrorHandler`
Extends	`yii\base\ErrorHandler` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`framework/console/ErrorHandler.php`

ErrorHandler handles uncaught PHP errors and exceptions.

ErrorHandler is configured as an application component in Application by default. You can access that instance via Yii::$app->errorHandler.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$discardExistingOutput`	`bool`	Whether to discard any existing page output before error display. Default: `true`.	`yii\base\ErrorHandler`
`$exception`	`Throwable\|null`	The exception that is being handled currently. Default: `null`.	`yii\base\ErrorHandler`
`$memoryReserveSize`	`int`	The size of the reserved memory. Default: `262144`.	`yii\base\ErrorHandler`
`$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`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`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\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clearOutput()`	Removes all output echoed before calling this method.	`yii\base\ErrorHandler`
`convertExceptionToString()` static	Converts an exception into a simple string.	`yii\base\ErrorHandler`
`convertExceptionToVerboseString()` static	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`
`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\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`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`
`formatMessage()` protected	Colorizes a message for console output.	`ErrorHandler`
`handleFallbackExceptionMessage()` protected	Handles exception thrown during exception processing in `handleException()`.	`yii\base\ErrorHandler`
`renderException()` protected	Renders an exception using ansi format for console output.	`ErrorHandler`

Events

Event	Type	Description	Defined by
`EVENT_SHUTDOWN`	`yii\base\Event`	An event that is triggered when the handler is called by shutdown function via `handleFatalError()`. Event name: `'shutdown'`. Available since 2.0.46.	`yii\base\ErrorHandler`

Method details

formatMessage()

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() (for details on how to specify the message format.)

renderException()

protected function renderException(Throwable $exception): mixed

Renders an exception using ansi format for console output.

Parameters

Parameter	Type	Description
`$exception`	`Throwable`	The exception to be rendered.

Returns

mixed