ConsoleErrorHandler (class)
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
Method Summary
- __construct() publicConstructor
- _displayError() protectedPrints an error to stderr.
- _displayException() protectedPrints an exception to stderr.
- _stop() protectedStop 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()source public
__construct( array $options [] )
Constructor
Parameters
- array
$options
optional [] - Options for the error handler.
_displayError()source 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()source protected
_displayException( Exception $exception )
Prints an exception to stderr.
Parameters
- Exception
$exception
- The exception to handle
_stop()source protected
_stop( integer $code )
Stop the execution and set the exit code for the process.
Parameters
- integer
$code
- The exit code.
Overrides
Cake\Error\BaseErrorHandler::_stop()
handleException()source 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
ExceptionWhen renderer class not found
See
http://php.net/manual/en/function.set-exception-handler.phpOverrides
Cake\Error\BaseErrorHandler::handleException()
Methods inherited from Cake\Error\BaseErrorHandler
_getMessage()source protected
_getMessage( Exception $exception )
Generates a formatted error message
Parameters
- Exception
$exception
- Exception instance
Returns
stringFormatted message
_logError()source 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
boolean_logException()source protected
_logException( Exception $exception )
Handles exception logging
Parameters
- Exception
$exception
- Exception instance.
Returns
boolean_requestContext()source 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
stringhandleError()source 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 > 0. And will log errors to Log, when debug == 0.
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
booleanTrue if error was handled
handleFatalError()source 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
booleanincreaseMemoryLimit()source public
increaseMemoryLimit( integer $additionalKb )
Increases the PHP "memory_limit" ini setting by the specified amount in kilobytes
Parameters
- integer
$additionalKb
- Number in kilobytes
mapErrorCode()source public static
mapErrorCode( integer $code )
Map an error code into an Error word, and log location.
Parameters
- integer
$code
- Error code to map
Returns
arrayArray of error word, and log location.
wrapAndHandleException()source 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
Properties detail
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Console.ConsoleErrorHandler.html