Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereuromark/cakephp-whoops
Whoops Error Handler for CakePHP - PHP errors and exceptions for cool kids
https://github.com/dereuromark/cakephp-whoops
Last synced: 12 days ago
JSON representation
Whoops Error Handler for CakePHP - PHP errors and exceptions for cool kids
- Host: GitHub
- URL: https://github.com/dereuromark/cakephp-whoops
- Owner: dereuromark
- License: mit
- Created: 2018-01-19T20:00:58.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-12T13:13:22.000Z (about 1 year ago)
- Last Synced: 2024-05-01T23:03:54.711Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 166 KB
- Stars: 13
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - CakephpWhoops plugin - PHP errors and exceptions for cool kids with [filp/whoops](https://github.com/filp/whoops). (Debugging)
README
# Whoops for CakePHP
[](https://github.com/dereuromark/cakephp-whoops/actions/workflows/ci.yml)
[](https://packagist.org/packages/dereuromark/cakephp-whoops)
[](https://packagist.org/packages/dereuromark/cakephp-whoops)
[](https://php.net/)
[](https://packagist.org/packages/dereuromark/cakephp-whoops)
Seamlessly integrate [Whoops] into [CakePHP] applications.
Demo-Video: [Linux Mint + Firefox](https://streamable.com/s/h63t3/xweicf)
This branch is for use with **CakePHP 5.0+**. For details see [version map](https://github.com/dereuromark/cakephp-whoops/wiki#cakephp-version-map).
## 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 `->addPlugin()` call). You only need to configure the renderer classes inside your `config/app.php` or `config/app_local.php`:
```php
'Error' => [
'exceptionRenderer' => \CakephpWhoops\Error\WhoopsExceptionRenderer::class,
'errorRenderer' => \CakephpWhoops\Error\WhoopsErrorRenderer::class
],
```
When using new Application.php and Middleware approach, you also need to adjust that:
```php
// Replace ErrorHandlerMiddleware with
->add(new \CakephpWhoops\Error\Middleware\WhoopsHandlerMiddleware(Configure::read('Error')))
```
### 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
```php
'Whoops' => [
'editor' => true,
],
```
To enable it.
If you are using a VM, e.g. CakeBox, you will also need the path mapping:
```php
'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:
After:
[CakePHP]:https://cakephp.org
[Composer]:https://getcomposer.org
[Whoops]:https://filp.github.io/whoops/