solis/phpbreaker

This package contains a set of exceptions shared across Solis components

v2.1.0 2017-10-20 18:40 UTC

This package is auto-updated.

Last update: 2022-05-21 23:32:52 UTC


README

Codacy Badge Codacy Badge Latest Stable Version License Build Status

This package contains a set of exceptions shared across Solis components.

Install

The best way to use this component is through Composer

composer require solis/phpbreaker

Usage

The simplest usage is to thrown a implementation of Solis\Breaker\ExceptionInterface.

    use Solis\Breaker\ExceptionInterface;
    use Solis\Exceptions\RuntimeException;

    try {
        thrown new RuntimeException('something bad here', 500);          
    } catch (ExceptionInterface $e){
        echo $e->getMessage();
        
        // you can get a representation of the exception as array, containing an error and a debug entry
        // $e->toArray();
        
        // same representation as before but in json format
        // $e->toJson();
        
        // get only the error entry as json representation
        // $e->getErrorAsJson();
        
        // get only the debug entry as json representation
        // $e->getDebugAsJson();
                       
        // its possible to set custom data to the error entry of the exception                                
        // $e->getError()->setEntry($entry, $data);
        
        // the same for the debug entry
        // $e->getDebug()->setEntry($entry, $data);                                      
    }    

All exceptions implemented in this package extends one of the SPL Exceptions. So its possible to catch normally with catch \Exception.

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

All feedback / bug reports / pull requests are welcome.

License

The MIT License (MIT). Please see License File for more information.