softius/exceptionist

Exception handler for PHP 5.3

0.3 2013-06-05 07:39 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: 3.*

Suggests

• eloquent/asplode: 1.*

MIT

• Iacovos Constantinou

• debug
• exceptions

README

Exceptionist provides exception handler for PHP 5.3+. Based on the application environment you can choose to display a detailed error report with stack trace or a mini report just mentioning the exception occured.

Installation

Exceptionist is available on packagist. All you need is to add the following lines in your project composer.json:

	{
    	"require": {
        	"softius/exceptionist": "0.1"
	    }
	}

and install via composer:

	php composer.phar install

Then, you will need to setup GenericExceptionHandler. You are adviced to setup the following as early as possible in your script.

set_exception_handler(array(new \Exceptionist\GenericExceptionHandler(array('project_root' => 'project_root_dir')), 'handle'));	

Configuration

GenericExceptionHandler accepts a configuration array with the following options:

• project_root: defines the project root directory, default is null.
• template_script: full path of the template to be used. The following built-in templates are available: \Exceptionist\ExceptionReporter::TEMPLATE_DETAILED
• code_block_length: number of lines to be displayed in each code block, default is 10.

How it works

ExceptionHandler is using ExceptionReporter class to generate and display exception reports. This happens only and only if an exception is thrown and not caught within a try/catch block. Templates are available in templates which can be copied, modified and adjusted to your needs, if necessary.