Class ConsoleErrorHandler
Error Handler for Cake console. Does simple printing of the exception that occurred and the stack trace of the error.
- Cake\Error\BaseErrorHandler
-
Cake\Console\ConsoleErrorHandler
Properties summary
Inherited Properties
Method Summary
-
__construct() public
Constructor -
_displayError() protected
Prints an error to stderr. -
_displayException() protected
Prints an exception to stderr. -
_stop() protected
Stop the execution and set the exit code for the process. -
handleException() public
Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.
Method Detail
__construct() public ¶
__construct( array $options = [] )
Constructor
Parameters
- array $options optional []
- Options for the error handler.
_displayError() protected ¶
_displayError( array $error , boolean $debug )
Prints an error to stderr.
Template method of BaseErrorHandler.
Parameters
- array $error
- An array of error data.
- boolean $debug
- Whether or not the app is in debug mode.
_displayException() protected ¶
_displayException( Exception $exception )
Prints an exception to stderr.
Parameters
- Exception $exception
- The exception to handle
_stop() protected ¶
_stop( integer $code )
Stop the execution and set the exit code for the process.
Parameters
- integer $code
- The exit code.
Overrides
handleException() public ¶
handleException( Exception $exception )
Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.
Parameters
- Exception $exception
- Exception instance.
Throws
When renderer class not found
See
Overrides
Methods inherited from Cake\Error\BaseErrorHandler
_getMessage() protected ¶
_getMessage( Exception $exception )
Generates a formatted error message
Parameters
- Exception $exception
- Exception instance
Returns
Formatted message
_logError() protected ¶
_logError( string $level , array $data )
Log an error.
Parameters
- string $level
- The level name of the log.
- array $data
- Array of error data.
Returns
_logException() protected ¶
_logException( Exception $exception )
Handles exception logging
Parameters
- Exception $exception
- Exception instance.
Returns
_requestContext() protected ¶
_requestContext( Cake\Http\ServerRequest $request )
Get the request context for an error/exception trace.
Parameters
-
Cake\Http\ServerRequest$request - The request to read from.
Returns
getMessageForException() protected ¶
getMessageForException( Exception $exception , boolean $isPrevious = false )
Generate the message for the exception
Parameters
- Exception $exception
- The exception to log a message for.
- boolean $isPrevious optional false
- False for original exception, true for previous
Returns
Error message
handleError() public ¶
handleError( integer $code , string $description , string|null $file = null , integer|null $line = null , array|null $context = null )
Set as the default error handler by CakePHP.
Use config/error.php to customize or replace this error handler. This function will use Debugger to display errors when debug mode is on. And will log errors to Log, when debug mode is off.
You can use the 'errorLevel' option to set what type of errors will be handled. Stack traces for errors can be enabled with the 'trace' option.
Parameters
- integer $code
- Code of error
- string $description
- Error description
- string|null $file optional null
- File on which error occurred
- integer|null $line optional null
- Line that triggered the error
- array|null $context optional null
- Context
Returns
True if error was handled
handleFatalError() public ¶
handleFatalError( integer $code , string $description , string $file , integer $line )
Display/Log a fatal error.
Parameters
- integer $code
- Code of error
- string $description
- Error description
- string $file
- File on which error occurred
- integer $line
- Line that triggered the error
Returns
increaseMemoryLimit() public ¶
increaseMemoryLimit( integer $additionalKb )
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
Parameters
- integer $additionalKb
- Number in kilobytes
mapErrorCode() public static ¶
mapErrorCode( integer $code )
Map an error code into an Error word, and log location.
Parameters
- integer $code
- Error code to map
Returns
Array of error word, and log location.
wrapAndHandleException() public ¶
wrapAndHandleException( Exception|Error $exception )
Checks the passed exception type. If it is an instance of Error
then, it wraps the passed object inside another Exception object
for backwards compatibility purposes.
Parameters
- Exception|Error $exception
- The exception to handle