dereuromark/cakephp-whoops

Whoops error handler for CakePHP

Installs: 25 337

Dependents: 2

Suggesters: 0

Stars: 12

Watchers: 2

Forks: 3

Open Issues: 0

Type:cakephp-plugin

0.1.3 2018-09-04 08:25 UTC

README

Build Status Total Downloads Latest Stable Version Minimum PHP Version License

Whoops for CakePHP

Seamlessly integrate Whoops into CakePHP 3 applications.

Demo-Video: Linux Mint + Firefox

Demo-Application: Sandbox

Install

Using Composer:

composer require dereuromark/cakephp-whoops

As this package only offers a Whoops handler for CakePHP, there is no need to enable it (no Plugin::load() call). You only need to configure that handler instead of CakePHP's own ErrorHandler by replacing the following line in bootstrap.php:

(new ErrorHandler(Configure::read('Error')))->register();

with the Whoops handler:

(new \CakephpWhoops\Error\WhoopsHandler(Configure::read('Error')))->register();

When using new Application.php and Middleware approach, you also need to adjust that:

// Replace ErrorHandlerMiddleware with
 ->add(new \CakephpWhoops\Error\Middleware\WhoopsHandlerMiddleware())

Debug Mode

An important note: This plugin is installed as require dependency, but even so it is more used as require-dev one. If the debug mode is off, it will completely ignore the Whoops handler, as without debug mode there is no exception to render. It will then display the public error message and only log internally.

So make sure you enable debug (locally) for checking out this package. For each error and exception you should then see the improved whoops handler output on your screen.

Editor

Opening the file in the editor via click in the browser is supported for most major IDEs. It uses phpstorm:// URLs which can open the file through a command line call and directly jump to the right line.

Set your config as

	'Whoops' => [
		'editor' => true,
	],

To enable it.

If you are using a VM, e.g. CakeBox, you will also need the path mapping:

		'userBasePath' => 'C:\wamp\www\cakebox\Apps\my-app.local',
		'serverBasePath' => '/home/vagrant/Apps/my-app.local',

If you would like to override the default URL handler (phpstorm://) you could do so by setting the ideLinkPattern option to a custom URL handler:

  • PhpStorm: phpstorm://open?file=%s&line=%s
  • Visual Studio Code: vscode://file/%s:%s

See the Wiki for more details on different OS and Browsers.

Strictness

As a bonus the error handler is a bit more strict here for development. It will not just ignore notices and other errors, but display them the same way in order to fix them with the same ease and speed as exceptions.

Usually, when a variable is not found, all following code can also not yield any useful results, as the example below shows. Better to code cleaner in the first place and to avoid any warning or notice to be thrown in the first place.

Before:

Screenshot

After:

Screenshot