ppito/laminas-whoops

Laminas-Whoops, integrated whoops in Laminas Framework

2.2.0 2021-06-16 16:50 UTC

Requires

• php: ^7.3 || ^8.0
• filp/whoops: ^2.7
• laminas/laminas-eventmanager: ^3.2
• laminas/laminas-mvc: ^3.1
• laminas/laminas-servicemanager: ^3.4

MIT

• Mickael TONNELIER

• whoops
• php error
• laminas

README

whoops is an error handler base/framework for PHP. Out-of-the-box, it provides a pretty error interface that helps you debug your web projects, but at heart it's a simple yet powerful stacked error handling system.

Table of Contents

• Module installation
• Features
  • Render View Manager - Twig Support
  • Module Visibility Manager
• License

Module installation

1. cd my/project/directory

2. create a composer.json file with following contents:

   {
       "require-dev": {
           "ppito/laminas-whoops": "^2.0"
       }
   }

3. install composer via curl -s http://getcomposer.org/installer | php (on windows, download http://getcomposer.org/installer and execute it with PHP)

4. run php composer.phar install

5. open my/project/directory/configs/modules.config.php and add the following key :

   'WhoopsErrorHandler', // must be added as the first module

6. optional : copy config/module.config.php in my/project/directory/config/autoload/laminas-whoops.local.php

7. optional : edit my/project/directory/config/autoload/laminas-whoops.local.php

Features

Render View Manager - Twig Support

By default this module use the simple php render, but you can now specify your favorite render.

Usage :

Twig render has been supported, you just need to change the template_render configuration:

'template_render' => 'laminas_whoops/twig_error',

Module Visibility Manager

It is now possible to manage the module loading by implement your own rules. For example, the module can be loaded only for the admin users or only for dev&preprod environments.

Usage :

• Create your own class by implement the interface VisibilityServiceInterface (or the abstract VisibilityServiceAbstract)
  • @see example VisibilityService.visibility-example.php.
• Change the visibility_service_name configuration to specify the name of your class.
  • @see example module.config.visibility-example.php.

  'visibility_service_name' => Application\Service\VisibilityService::class,

Ignored Exceptions

By default, this module will route all exceptions to Whoops; however, you can create a list of exception classes that will be ignored by Whoops.

Usage:

Set the ignored_exceptions configuration to an array of class names:

'ignored_exceptions' => [My\Exception::class, My\OtherException::class]

License

ppito/laminas-whoops is licensed under the MIT License - See the LICENSE file for details.