README

Turn PHP errors into D&D encounter messages.

Installation

composer require calvert/php-dnd-errors

Usage

Simply boot the error handler in your application:

<?php

require_once __DIR__ . '/vendor/autoload.php';

use Calvert\DndErrors\DndErrors;

DndErrors::boot([
    'archetype' => 'wizard', // 'paladin', 'ranger', 'wizard', or 'random'
    'exit' => true, // default: true
]);

Options

archetype: 'paladin', 'ranger', 'wizard', or 'random' (default: 'random')
exit: true or false - Whether to exit after rendering uncaught errors (default: true)

Features

Captures uncaught exceptions
Converts PHP errors to exceptions
Handles fatal errors
Themed error messages with D&D archetype personality
Context-aware flavor text based on error types

Example

<?php

require_once __DIR__ . '/vendor/autoload.php';

use Calvert\DndErrors\DndErrors;

DndErrors::boot(['archetype' => 'paladin']);

// Trigger an error
$array = null;
count($array);

TODO

Additional Classes

We're planning to add more D&D classes as archetypes! If you'd like a specific class added sooner, feel free to open a pull request.

Some ideas for future classes:

Bard
Cleric
Fighter
Rogue
Sorcerer
...and more!

Development

This project uses PHP CodeSniffer with PSR-12 standard for code quality and PHPUnit for testing.

# Run tests
composer test

# Check code style
composer check

# Auto-fix code style issues
composer fix

# Or use vendor binaries directly
vendor/bin/phpunit
vendor/bin/phpcs --standard=PSR12 src/
vendor/bin/phpcbf --standard=PSR12 src/

License

MIT

calvert / php-dnd-errors

Maintainers

Package info

Statistics

Security