CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.1 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.1
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
      • Exception
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class ConsoleErrorHandler

Error Handler for Cake console. Does simple printing of the exception that occurred and the stack trace of the error.

Namespace: Cake\Console

Property Summary

  • $_options protected
    array

    Options for this instance.

  • $_stderr protected
    ConsoleOutput

    Standard error stream.

Method Summary

  • __construct() public

    Constructor

  • _displayError() protected

    Prints an error to stderr.

  • _displayException() protected

    Prints an exception to stderr.

  • _getMessage() protected

    Generates a formatted error message

  • _logError() protected

    Log an error.

  • _logException() protected

    Handles exception logging

  • _stop() protected

    Stop the execution and set the exit code for the process.

  • handleError() public

    Set as the default error handler by CakePHP.

  • handleException() public

    Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.

  • handleFatalError() public

    Display/Log a fatal error.

  • mapErrorCode() public static

    Map an error code into an Error word, and log location.

  • register() public

    Register the error and exception handlers.

  • wrapAndHandleException() public

    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.

Method Detail

__construct() ¶ public

__construct(array $options = [])

Constructor

Parameters
array $options optional

Options for the error handler.

_displayError() ¶ protected

_displayError(array $error, bool $debug): void

Prints an error to stderr.

Template method of BaseErrorHandler.

Parameters
array $error

An array of error data.

bool $debug

Whether or not the app is in debug mode.

Returns
void

_displayException() ¶ protected

_displayException(Exception $exception): void

Prints an exception to stderr.

Subclasses should implement this method to display an uncaught exception as desired for the runtime they operate in.

Parameters
Exception $exception

The exception to handle

Returns
void

_getMessage() ¶ protected

_getMessage(Exception $exception): string

Generates a formatted error message

Parameters
Exception $exception

Exception instance

Returns
string

_logError() ¶ protected

_logError(string $level, array $data): bool

Log an error.

Parameters
string $level

The level name of the log.

array $data

Array of error data.

Returns
bool

_logException() ¶ protected

_logException(Exception $exception): bool

Handles exception logging

Parameters
Exception $exception

Exception instance.

Returns
bool

_stop() ¶ protected

_stop(int $code): void

Stop the execution and set the exit code for the process.

Implemented in subclasses that need it.

Parameters
int $code

The exit code.

Returns
void

handleError() ¶ public

handleError(int $code, string $description, string|null $file = null, int|null $line = null, array|null $context = null): bool

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
int $code

Code of error

string $description

Error description

string|null $file optional

File on which error occurred

int|null $line optional

Line that triggered the error

array|null $context optional

Context

Returns
bool

handleException() ¶ public

handleException(Exception $exception): void

Handle errors in the console environment. Writes errors to stderr, and logs messages if Configure::read('debug') is false.

Uses a template method provided by subclasses to display errors in an environment appropriate way.

Parameters
Exception $exception

Exception instance.

Returns
void
Throws
Exception
When renderer class not found
See Also
http://php.net/manual/en/function.set-exception-handler.php

handleFatalError() ¶ public

handleFatalError(int $code, string $description, string $file, int $line): bool

Display/Log a fatal error.

Parameters
int $code

Code of error

string $description

Error description

string $file

File on which error occurred

int $line

Line that triggered the error

Returns
bool

mapErrorCode() ¶ public static

mapErrorCode(int $code): array

Map an error code into an Error word, and log location.

Parameters
int $code

Error code to map

Returns
array

register() ¶ public

register(): void

Register the error and exception handlers.

Returns
void

wrapAndHandleException() ¶ public

wrapAndHandleException(Exception|Error $exception): void

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

Returns
void

Property Detail

$_options ¶ protected

Options for this instance.

Type
array

$_stderr ¶ protected

Standard error stream.

Type
ConsoleOutput
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs