webfiori/err

A library for handling PHP errors and exceptions in a better way.

v1.1.0 2024-06-26 21:03 UTC

Requires

• php: >=7.0

MIT

• Ibrahim BinAlshikh

• php
• errors
• error handler
• exception
• error

README

A library for handling PHP errors and exceptions in a better way.

Supported PHP Versions

Installation

The library can be included in your project by including following entry in your require section of your composer.json: "webfiori/err":"*".

Features

• Conversion of all PHP errors to exceptions.
• Ability to create a custom exceptions' handler.
• Provides OOP abstraction for the function set_exception_handler()

Usage

The library has two main classes that the developer will work with. The first one is the class Handler and the second class is AbstractExceptionHandler. The first class is the core of the library. It is used to set custom exception handler. The second class is used to implement custom exception handler. Since the library will convert all PHP errors to exceptions, no need for the developer to have a custom errors handler.

Implementing a Custom Exceptions Handler

First step in setting a custom exceptions handler is to implement one. Implementing a custom handler is strait forward procedure. Simply, the developer have to extend the class AbstractExceptionHandler and implement one abstract method of the class. The method AbstractExceptionHandler::handle() is used to handle the exception. The developer can have access to the properties of the thrown exception in order to handle it properly. The library comes with one default exceptions handler which can act as good example in how to implement a custom handler.

<?php
namespace webfiori\error;

class DefaultExceptionsHandler extends AbstractExceptionHandler {
    public function __construct() {
        parent::__construct();

        //Set handler name. Each registered handler must have a unique name.
        $this->setName('Cool Handler');

        //Sets the priority of the handler. Larger means that it has higher priority.
        $this->setPriority(100);
    }
    /**
     * Handles the exception.
     */
    public function handle() {
        echo '<pre>';
        echo 'An exception was thrown at '.$this->getClass().' line '.$this->getLine().'.<br>';
        echo 'Exception message: '.$this->getMessage().'.<br>';
        echo 'Stack trace:<br>';
        $trace = $this->getTrace();
        
        if (count($trace) == 0) {
            echo '&lt;Empty&gt;';
        } else {
            $index = '0';

            foreach ($trace as $entry) {
                echo '#'.$index.' '.$entry.'<br>';
                $index++;
            }
        }
        echo '</pre>';
    }

    public function isActive(): bool {
        //Activate or deactivate the handler based on conditions.
        return true;
    }

    public function isShutdownHandler(): bool {
        //Set the handler as shutdown handler (errors after processing)
        return false;
    }
}

Setting a Custom Exceptions Handler

After implementing the handler, the developer must set it as exceptions handler. To do that, simply the developer have to use the static method Handler::registerHandler() in any place in his project.

Handler::registerHandler(new DefaultExceptionsHandler());