readme and phpdocs

Author: dmitry-suffi

Readme.md

@@ -1 +1,63 @@
-ErrorHandler
+ErrorHandler
+============
+
+Error handling php. Can use any logger psr-3 for logging errors.
+
+Installation
+------------
+```
+composer require dmitry-suffi/error-handler
+```
+
+connection example
+------------------
+
+```php
+
+$handler = new \suffi\ErrorHandler\ErrorHandler();
+
+set_error_handler([$handler, 'errorHandler']);
+set_exception_handler([$handler, 'exceptionHandler']);
+
+```
+
+Setting
+-------
+
+Debug mode. Displays error details.
+```php
+
+$handler->debug = true;
+
+```
+
+Error Logging. Can use any logger psr-3 for logging errors.
+```php
+
+$handler->writeLog = true;
+
+$handler->logger = $logger;
+
+```
+
+Writing to the log information
+```php
+
+$handler->$debugLog = true;
+
+```
+
+When you inherit from the class, you can change the way display messages to the user fault conditioning.
+```php
+    //Page with an error message
+    protected function htmlError(string $errstr)
+    {
+        return $errstr;
+    }
+
+    //Report an error for ajax-request
+    protected function jsonError(string $errstr)
+    {
+        return json_encode(['error' => $errstr]);
+    }
+```

src/ErrorHandler.php

@@ -38,7 +38,7 @@ class ErrorHandler
     public $debugLog = false;
 
     /**
-     * Метод перехвата ошибок
+     * Method error trapping
      * @param int $errno
      * @param string $errstr
      * @param string $errfile
@@ -51,7 +51,7 @@ public function errorHandler(int $errno, string $errstr, string $errfile = '', i
     }
 
     /**
-     * Метод перехвата исключений
+     * Exceptions intercept method
      * @param \Throwable $ex
      */
     public function exceptionHandler(\Throwable $ex)
@@ -60,7 +60,7 @@ public function exceptionHandler(\Throwable $ex)
     }
 
     /**
-     * Обработка исключений
+     * Exception Handling
      * @param \Throwable $ex
      */
     protected function handler(\Throwable $ex)
@@ -83,7 +83,7 @@ protected function handler(\Throwable $ex)
     }
 
     /**
-     * Определение по типу
+     * Determination of type
      * @param int $errno
      * @return bool
      */
@@ -114,7 +114,7 @@ protected function isError(int $errno):bool
     }
 
     /**
-     * Определение типа сообщения в логе по типу ошибки
+     * Determining the type of message in the log for the error type
      * @param int $errno
      * @return bool
      */
@@ -148,7 +148,7 @@ protected function getLogLevel(int $errno):bool
     }
 
     /**
-     * Выбрасывает 500й статус и текст с ошибкой
+     * Throws 500y status and the text of the error
      * @param string $errstr
      */
     protected function page500(string $errstr)
@@ -169,7 +169,7 @@ protected function page500(string $errstr)
     }
 
     /**
-     * Парсинг шаблона
+     * Parsing template
      * @param \Throwable $ex
      * @param string $code
      * @return mixed
@@ -190,7 +190,7 @@ protected function parseDebug(\Throwable $ex, $code = '')
     }
 
     /**
-     * Добавление глобальных переменных в строку
+     * Adding global variables in a row
      * @param $fullMessage
      * @return string
      */
@@ -232,7 +232,7 @@ protected function addGlobals($fullMessage)
     }
 
     /**
-     * Сообщение об ошибке в html
+     * Error message in html
      * @param string $errstr
      * @return string
      */
@@ -249,7 +249,7 @@ protected function htmlError(string $errstr)
     }
 
     /**
-     * Сообщение об ошибке в json
+     * Error message in json
      * @param string $errstr
      * @return string
      */
@@ -259,7 +259,7 @@ protected function jsonError(string $errstr)
     }
 
     /**
-     * Запись в логи об ошибке
+     * Record error logs
      * @param \Throwable $ex
      */
     protected function log(\Throwable $ex)
@@ -275,7 +275,7 @@ protected function log(\Throwable $ex)
     }
 
     /**
-     * Информация об ошибке
+     * Error Information
      * @param \Throwable $ex
      */
     protected function debugError(\Throwable $ex)