README

Translations: Español

PHP library for handling exceptions.

To handle exceptions you can use the exception-handler library.

Requirements
Installation
Available Classes
Exceptions Used
Usage
Tests
TODO
Changelog
Contribution
Sponsor
License

Requirements

Operating System: Linux | Windows.
PHP versions: 8.1.

Installation

The preferred way to install this extension is through Composer.

To install PHP ErrorHandler library, simply:

composer require josantonius/error-handler

The previous command will only install the necessary files, if you prefer to download the entire source code you can use:

composer require josantonius/error-handler --prefer-source

You can also clone the complete repository with Git:

git clone https://github.com/josantonius/php-error-handler.git

Available Classes

ErrorException Class

Josantonius\ErrorHandler\ErrorException Extends ErrorException

Gets error file:

public function getFile(): string;

Gets error level:

public function getLevel(): int;

Gets error file line:

public function getLine(): int;

Gets error message:

public function getMessage(): string;

Gets error name:

public function getName(): string;

ErrorHandled Class

Josantonius\ErrorHandler\ErrorHandled

Gets error file:

public function getFile(): string;

Gets error level:

public function getLevel(): int;

Gets error file line:

public function getLine(): int;

Gets error message:

public function getMessage(): string;

Gets error name:

public function getName(): string;

ErrorHandler Class

Josantonius\ErrorHandler\ErrorHandler

Convert errors to exceptions:

/**
 * The errors will be thrown from the ErrorException instance.
 * 
 * @param int[] $errorLevel Define the specific error levels that will become exceptions.
 * 
 * @throws WrongErrorLevelException if error level is not valid.
 * 
 * @see https://www.php.net/manual/en/errorfunc.constants.php to view available error levels.
 */
public function convertToExceptions(int ...$errorLevel): ErrorHandler;

Convert errors to exceptions except for some of them:

/**
 * The errors will be thrown from the ErrorException instance.
 * 
 * @param int[] $errorLevel Define the specific error levels that will become exceptions.
 * 
 * @throws WrongErrorLevelException if error level is not valid.
 * 
 * @see https://www.php.net/manual/en/errorfunc.constants.php to view available error levels.
 */
public function convertToExceptionsExcept(int ...$errorLevel): ErrorHandler;

/**
 * The error handler will receive the ErrorHandled object.
 * 
 * @see https://www.php.net/manual/en/functions.first_class_callable_syntax.php
 */
public function register(callable $callback): ErrorHandler;

Use error reporting to determine which errors are handled:

/**
 * If the setting value in error_reporting() is used to determine which errors are handled.
 *
 * If this method is not used, all errors will be sent to the handler.
 *
 * @see https://www.php.net/manual/en/function.error-reporting.php
 */
public function useErrorReportingLevel(): ErrorHandler;

Exceptions Used

use Josantonius\ErrorHandler\Exceptions\WrongErrorLevelException;

Usage

Examples of use for this library:

Convert all errors to exceptions

use Josantonius\ErrorHandler\ErrorHandler;

$errorHandler = new ErrorHandler();

$errorHandler->convertToExceptions();

// All errors will be converted to exceptions.

Convert certain errors to exceptions

use Josantonius\ErrorHandler\ErrorHandler;

$errorHandler = new ErrorHandler();

$errorHandler->convertToExceptions(E_USER_ERROR, E_USER_WARNING);

// Only E_USER_ERROR and E_USER_WARNING will be converted to exceptions.

Convert all errors to exceptions except for some of them

use Josantonius\ErrorHandler\ErrorHandler;

$errorHandler = new ErrorHandler();

$errorHandler->convertToExceptionsExcept(E_USER_DEPRECATED, E_USER_NOTICE);

// All errors except E_USER_DEPRECATED and E_USER_NOTICE will be converted to exceptions.

Convert to exceptions using error reporting level

use Josantonius\ErrorHandler\ErrorHandler;

error_reporting(E_USER_ERROR);

$errorHandler = new ErrorHandler();

$errorHandler->convertToExceptions()->useErrorReportingLevel();

// Only E_USER_ERROR will be converted to exception.

Convert to exceptions and use an exception handler

use ErrorException;
use Josantonius\ErrorHandler\ErrorHandler;

set_exception_handler(function (ErrorException $exception) {
    var_dump([
        'level'   => $exception->getLevel(),
        'message' => $exception->getMessage(),
        'file'    => $exception->getFile(),
        'line'    => $exception->getLine(),
        'name'    => $exception->getName(),
    ]);
});

$errorHandler = new ErrorHandler();

$errorHandler->convertToExceptions();

// All errors will be converted to exceptions.

Register an error handler function

use Josantonius\ErrorHandler\ErrorHandled;
use Josantonius\ErrorHandler\ErrorHandler;

function handler(Errorhandled $errorHandled): void {
    var_dump([
        'level'   => $errorHandled->getLevel(),
        'message' => $errorHandled->getMessage(),
        'file'    => $errorHandled->getFile(),
        'line'    => $errorHandled->getLine(),
        'name'    => $errorHandled->getName(),
    ]);
 }

$errorHandler = new ErrorHandler();

$errorHandler->register(
    callback: handler(...)
);

// All errors will be converted to exceptions.

Register error handler function and convert to exceptions

use Josantonius\ErrorHandler\ErrorHandled;
use Josantonius\ErrorHandler\ErrorHandler;

class Handler {
    public static function errors(Errorhandled $exception): void { /* do something */ }
}

$errorHandler = new ErrorHandler();

$errorHandler->register(
    callback: Handler::errors(...)
)->convertToExceptions();

// The error will be sent to the error handler and then throw the exception.

Register error handler function, convert to exceptions and use error reporting level

error_reporting(E_USER_ERROR);

class Handler {
    public function errors(Errorhandled $exception): void { /* do something */ }
}

$handler = new Handler();

$errorHandled->register(
    callback: $handler->errors(...),
)->convertToExceptions()->useErrorReportingLevel();

// Only E_USER_ERROR will be passed to the handler and converted to exception.

Tests

To run tests you just need composer and to execute the following:

git clone https://github.com/josantonius/php-error-handler.git

cd php-error-handler

composer install

Run unit tests with PHPUnit:

composer phpunit

Run code standard tests with PHPCS:

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:

composer phpmd

Run all previous tests:

composer tests

TODO

Add new feature
Improve tests
Improve documentation
Improve English translation in the README file
Refactor code for disabled code style rules (see phpmd.xml and phpcs.xml)

Changelog

Detailed changes for each release are documented in the release notes.

Contribution

Please make sure to read the Contributing Guide, before making a pull request, start a discussion or report a issue.

Thanks to all contributors! ❤️

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊

License

This repository is licensed under the MIT License.

josantonius / error-handler

Maintainers

Details