php error handler

Библиотека PHP ErrorHandler

Переводы : Испанский

PHP-библиотека для обработки исключений.

Для обработки исключений вы можете использовать библиотеку обработчиков исключений.

---

• Требования
• Установка
• Доступные классы
  • Класс ErrorException
  • Класс ErrorHandled
  • Класс ErrorHandler
• Используемые исключения
• Использование
• Тесты
• TODO
• Журнал изменений
• Вклад
• Спонсор
• Лицензия

---

Требования

• Операционная система: Linux | Окна.

• Версии PHP: 8.1.

Установка

Предпочтительный способ установки этого расширения — через Composer.

Чтобы установить библиотеку PHP ErrorHandler , просто:

 composer require josantonius/error-handler

Предыдущая команда установит только необходимые файлы, если вы предпочитаете загрузить весь исходный код, вы можете использовать:

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

Вы также можете клонировать весь репозиторий с помощью Git:

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

Доступные классы

Класс ErrorException

JosantoniusErrorHandlerErrorException расширяет ErrorException

Получает файл ошибки:

 public function getFile(): string ;

Получает уровень ошибки:

 public function getLevel(): int ;

Получает строку файла ошибки:

 public function getLine(): int ;

Получает сообщение об ошибке:

 public function getMessage(): string ;

Получает имя ошибки:

 public function getName(): string ;

Класс ErrorHandled

JosantoniusErrorHandlerErrorHandled

Получает файл ошибки:

 public function getFile(): string ;

Получает уровень ошибки:

 public function getLevel(): int ;

Получает строку файла ошибки:

 public function getLine(): int ;

Получает сообщение об ошибке:

 public function getMessage(): string ;

Получает имя ошибки:

 public function getName(): string ;

Класс ErrorHandler

JosantoniusErrorHandlerErrorHandler

Преобразуйте ошибки в исключения:

 /**
 * 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 ;

Преобразуйте ошибки в исключения, за исключением некоторых:

 /**
 * 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 ;

Используйте отчеты об ошибках, чтобы определить, какие ошибки обрабатываются:

 /**
 * 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 ;

Используемые исключения

 use Josantonius  ErrorHandler  Exceptions  WrongErrorLevelException ;

Использование

Примеры использования этой библиотеки:

Преобразовать все ошибки в исключения

 use Josantonius  ErrorHandler  ErrorHandler ;

$ errorHandler = new ErrorHandler ();

$ errorHandler -> convertToExceptions ();

// All errors will be converted 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.

Преобразуйте все ошибки в исключения, кроме некоторых из них.

 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.

Преобразование в исключения с использованием уровня отчетов об ошибках

 use Josantonius  ErrorHandler  ErrorHandler ;

error_reporting ( E_USER_ERROR );

$ errorHandler = new ErrorHandler ();

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

// Only E_USER_ERROR will be converted to exception.

Преобразование в исключения и использование обработчика исключений

 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.

Зарегистрируйте функцию обработчика ошибок

 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.

Зарегистрируйте функцию обработчика ошибок и преобразуйте ее в исключения

 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.

Зарегистрируйте функцию обработчика ошибок, преобразуйте ее в исключения и используйте уровень сообщения об ошибках.

 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. 

Тесты

Для запуска тестов вам просто нужен композитор и выполните следующее:

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

 cd php-error-handler 

 composer install

Запустите модульные тесты с помощью PHPUnit:

 composer phpunit

Запустите стандартные тесты кода с помощью PHPCS:

 composer phpcs

Запустите тесты PHP Mess Detector, чтобы обнаружить несоответствия в стиле кода:

 composer phpmd

Запустите все предыдущие тесты:

 composer tests 

TODO

• Добавить новую функцию
• Улучшить тесты
• Улучшить документацию
• Улучшите английский перевод в файле README.
• Рефакторинг кода для отключенных правил стиля кода (см. phpmd.xml и phpcs.xml).

Журнал изменений

Подробные изменения для каждого выпуска описаны в примечаниях к выпуску.

Вклад

Обязательно прочтите Руководство для участников, прежде чем делать запрос на включение, начинать обсуждение или сообщать о проблеме.

Спасибо всем участникам! ❤️

Спонсор

Если этот проект поможет вам сократить время разработки, вы можете спонсировать меня для поддержки моей работы с открытым исходным кодом?

Лицензия

Этот репозиторий лицензируется по лицензии MIT.

Copyright © 2016-настоящее время, Джосантониус