lefuturiste/slim-whoops

PHP whoops error on slim framework

Slim whoops

PHP whoops error on slim framework, _(*1)

Status

, _(*2)

Installation

Install the composer, _(*3)

curl -sS https://getcomposer.org/installer | php

Edit composer.json, _(*4)

For Slim framework 3, The composer.json will looks like, _(*5)

{
    "require": {
        "zeuxisoo/slim-whoops": "0.6.*"
    }
}

Now, install or update the dependencies, _(*6)

php composer.phar install

Usage

Just need to add the middleware in your slim application., _(*7)

Simple way, _(*8)

In this case, You must ensure this line is first added and on top of other middlewares, _(*9)

$app->add(new \Zeuxisoo\Whoops\Provider\Slim\WhoopsMiddleware);
$app->add(new \Other\MiddlewareA);
$app->add(new \Other\MiddlewareB);

Better DI, _(*10)

In this case, You can place this line anywhere no position required, _(*11)

$app->add(new \Zeuxisoo\Whoops\Provider\Slim\WhoopsMiddleware($app));

Global mode, _(*12)

In this case, The following code can make Whoops errors in the global scope, whether you have destroyed the program's life cycle, _(*13)

$whoopsGuard = new \Zeuxisoo\Whoops\Provider\Slim\WhoopsGuard();
$whoopsGuard->setApp($app);
$whoopsGuard->setRequest($container['request']);
$whoopsGuard->setHandlers([]);
$whoopsGuard->install();

Custom Whoops Handler, _(*14)

In this case, You can push custom handler to whoops. For example:, _(*15)

A handler like:, _(*16)

$simplyErrorHandler = function($exception, $inspector, $run) {
    $message = $exception->getMessage();
    $title   =  $inspector->getExceptionName();

    echo "{$title} -> {$message}";
    exit;
};

Middleware case like:, _(*17)

new \Zeuxisoo\Whoops\Provider\Slim\WhoopsMiddleware($app, [$simplyErrorHandler]);

Global mode case like:, _(*18)

$whoopsGuard = new \Zeuxisoo\Whoops\Provider\Slim\WhoopsGuard();
$whoopsGuard->setHandlers([$simplyErrorHandler]);

Options

Opening referenced files with your favorite editor or IDE, _(*19)

$app = new App([
    'settings' => [
         // Enable whoops
        'debug'         => true,

        // Support click to open editor
        'whoops.editor' => 'sublime',

        // Display call stack in orignal slim error when debug is off
        'displayErrorDetails' => true,
    ]
]);

Important Note

Version 0.3.0, _(*20)

• The whoops library is installed by default base on the [Whoops Framework Integration Document][1]

Version 0.2.0, _(*21)

• You must to install the whoops library manually.

Testing

Run the test cases, _(*22)

php vendor/bin/phpunit