Class yii\console\ErrorHandler
| Inheritance | yii\console\ErrorHandler » yii\base\ErrorHandler » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/console/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.
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 |
|---|---|---|
| formatMessage() | Colorizes a message for console output. | yii\console\ErrorHandler |
| handleFallbackExceptionMessage() | Handles exception thrown during exception processing in handleException(). | yii\base\ErrorHandler |
| renderException() | Renders an exception using ansi format for console output. | yii\console\ErrorHandler |
Method Details
Colorizes a message for console output.
See also yii\helpers\Console::ansiFormat() for details on how to specify the message format.
| protected string formatMessage ( $message, $format = [\yii\helpers\Console::FG_RED, \yii\helpers\Console::BOLD] ) | ||
| $message | string | The message to colorize. |
| $format | array | The message format. |
| return | string | The colorized message. |
|---|---|---|
Renders an exception using ansi format for console output.
| protected void renderException ( $exception ) | ||
| $exception | Exception | The exception to be rendered. |