php errors for cool kids
Pull request Compare This branch is 747 commits behind filp:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src/Damnit
tests
.gitignore
.travis.yml
LICENSE.md
README.md
composer.json
composer.lock
phpunit.xml.dist

README.md

damnit

php errors for cool kids

Build Status


Damnit!

damnit 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.

This library is currently in a heavy development phase, and may catch on fire at any moment.

(current) Features

  • Flexible, stack-based error handling
  • Stand-alone library with (currently) no required dependencies
  • Simple API for dealing with exceptions, trace frames & their data
  • Includes a pretty rad error page for your webapp projects
  • Includes a DamnitServiceProvider for painless integration with Silex
  • Easy to extend and integrate with existing libraries
  • Clean, well-structured & tested code-base (well, except pretty-template.php, for now...)

Installing

  • Install Composer and place the executable somewhere in your $PATH (for the rest of this README, I'll reference it as just composer)

  • Add filp/damnit to your project's `composer.json:

{
    "require": {
        "filp/damnit": "dev-master"
    }
}
  • Install/update your dependencies
$ cd my_project
$ composer install

And you're good to go! Have a look at the example files in examples/ to get a feel for how things work. I promise it's really simple!

Integrating with Silex

damnit comes packaged with a Silex Service Provider: Damnit\Silex\DamnitServiceProvider. Using it in your existing Silex project is easy:


require 'vendor/autoload.php';

use Silex\Application;

// ... some awesome code here ...

if($app['debug']) {
    $app->register(new Damnit\Silex\DamnitServiceProvider);
}

// ...

$app->run();

And that's about it. By default, you'll get the pretty error pages if something goes awry in your development environment, but you also have full access to the damnit library, obviously. For example, adding a new handler into your app is as simple as extending damnit:

$app['damnit'] = $app->extend('damnit', function($damnit) {
    $damnit->pushHandler(new DeleteWholeProjectHandler);
    return $damnit;
});

Contributing

If you want to help, great! Here's a couple of steps/guidelines:

  • Fork/clone this repo, and update dev dependencies using Composer
$ git clone git@github.com:filp/damnit.git
$ cd damnit
$ composer install --dev
  • Create a new branch for your feature or fix
$ git checkout -b feature/flames-on-the-side
  • Add your changes & tests for those changes (in tests/).
  • Remember to stick to the existing code style as best as possible. When in doubt, follow PSR-2.
  • Send me a pull request!

If you don't want to go through all this, but still found something wrong or missing, please open a new issue report so that I or others may take care of it.

TODO/tasks (very short & rough list of current goals)

  • Improve code view
  • Improve UI in situations where there's a very long frame list
  • Delay prettify until needed, instead of doing it for every frame at once
  • Cleanup API, specially around Frame handling
  • Add extension hooks for PrettyPageHandler
  • Improve test coverage