ErrorHandler
- Type
- Class
- Namespace
- craft\console
- Inherits
- craft\console\ErrorHandler » yii\console\ErrorHandler (opens new window) » yii\base\ErrorHandler (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.7.18
Class ErrorHandler
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| discardExistingOutput (opens new window) | boolean (opens new window) – Whether to discard any existing page output before error display. |
| exception (opens new window) | Throwable (opens new window), null (opens new window) – The exception that is being handled currently. |
| memoryReserveSize (opens new window) | integer (opens new window) – The size of the reserved memory. |
| silentExitOnException (opens new window) | boolean (opens new window) – If true - handleException() will finish script with ExitCode::OK. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| clearOutput() (opens new window) | Removes all output echoed before calling this method. |
| convertExceptionToError() (opens new window) | Converts an exception into a PHP error. |
| convertExceptionToString() (opens new window) | Converts an exception into a simple string. |
| convertExceptionToVerboseString() (opens new window) | Converts an exception into a string that has verbose information about the exception and its trace. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
| handleError() (opens new window) | Handles PHP execution errors such as warnings and notices. |
| handleException() | Handles uncaught PHP exceptions. |
| handleFatalError() (opens new window) | Handles fatal PHP errors. |
| handleHhvmError() (opens new window) | Handles HHVM execution errors such as warnings and notices. |
| hasEventHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() (opens new window) | |
| logException() (opens new window) | Logs the given exception. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| register() (opens new window) | Register this error handler. |
| trigger() (opens new window) | Triggers an event. |
| unregister() (opens new window) | Unregisters this error handler by restoring the PHP error and exception handlers. |
# handleException()
Handles uncaught PHP exceptions.
This method is implemented as a PHP exception handler.
View source (opens new window)
Arguments
$exception(Throwable (opens new window)) – The exception that is not caught
# Protected Methods
| Method | Description |
|---|---|
| formatMessage() (opens new window) | Colorizes a message for console output. |
| handleFallbackExceptionMessage() (opens new window) | Handles exception thrown during exception processing in handleException() (opens new window). |
| renderException() (opens new window) | Renders an exception using ansi format for console output. |
# Events
# EVENT_BEFORE_HANDLE_EXCEPTION
The event that is triggered before handling an exception.