nkovacs/yii-whoops

Whoops integration class for Yii Framework 1.1

v1.3.0 2014-06-02 08:39 UTC

This package is auto-updated.

Last update: 2024-02-25 02:00:14 UTC


README

Integrates the Whoops library into Yii 1.1.

This error handler replaces the built-in exception views with Whoops. Your error action (or Yii's built-in error views, if errorAction is not set) is used if your application is not in debug mode (i.e. YII_DEBUG is false), or the exception is a CHttpException.

Usage

  1. Install it:

    • Using Composer (it will automatically install Whoops main libraries as well):
    composer require igorsantos07/yii-whoops:1
    composer install
    • Or downloading and unpacking it in your extensions folder.
  2. If you're using Composer, I strongly recomend you create a vendor alias if you haven't yet. Add this to the beginning of your config/main.php:

    Yii::setPathOfAlias('vendor', __DIR__.'/../../vendor');
  3. Replace your errorHandler entry at config/main.php with the error handler class. Example:

    'errorHandler' => ['class' => 'vendor.nkovacs.yii-whoops.WhoopsErrorHandler']

    If you're using Composer's autoloader, you can simply use 'WhoopsErrorHandler'. You must require 'vendor/autoload.php' in your entry scripts (index.php, yiic.php etc.) for this to work.

  4. If you're using some custom LogRoute that binds to the application's end, you can disable it using the component's disabledLogRoutes property. Just set it to an array containing all the classnames (not aliases!) of each route you want disabled whenever Whoops is launched. By default it disables the famous Yii Debug Toolbar; if you want to keep it enabled, override the defaultDisabledLogRoutes property.

    'errorHandler' => [
        'class'             => 'vendor.nkovacs.yii-whoops.WhoopsErrorHandler',
        'disabledLogRoutes' => 'MyCustomRouteClass'
    ]

Sample screenshot

687474703a2f2f692e696d6775722e636f6d2f70717438664b342e706e67