General updates

Author: Awilum

ErrorHandler.php

@@ -35,13 +35,12 @@ class ErrorHandler
     /**
      * Returns an array of lines from a file.
      *
-     * @access  public
      * @param  string $file    File in which you want to highlight a line
      * @param  int    $line    Line number to highlight
      * @param  int    $padding (optional) Number of padding lines
      * @return array
      */
-    protected static function highlightCode($file, $line, $padding = 6)
+    protected static function highlightCode(string $file, int $line, int $padding = 6) : array
     {
         if ( ! is_readable($file)) {
             return false;
@@ -78,13 +77,13 @@ protected static function highlightCode($file, $line, $padding = 6)
     /**
      * Converts errors to ErrorExceptions.
      *
-     * @param  integer $code    The error code
+     * @param  int     $code    The error code
      * @param  string  $message The error message
      * @param  string  $file    The filename where the error occurred
-     * @param  integer $line    The line number where the error occurred
-     * @return boolean
+     * @param  int     $line    The line number where the error occurred
+     * @return bool
      */
-    public static function error($code, $message, $file, $line)
+    public static function error(int $code, string $message, string $file, int $line) : bool
     {
         // If isset error_reporting and $code then throw new error exception
         if ((error_reporting() & $code) !== 0) {
@@ -111,7 +110,7 @@ public static function error($code, $message, $file, $line)
                 ErrorHandler::writeLogs("{$error['type']}: {$error['message']} in {$error['file']} at line {$error['line']}");
 
             } else {
-                throw new ErrorException($message, $code, 0, $file, $line);
+                throw new \ErrorException($message, $code, 0, $file, $line);
             }
         }
 
@@ -125,7 +124,7 @@ public static function error($code, $message, $file, $line)
      * @param  string $string String
      * @return string
      */
-    protected static function highlightString($string)
+    protected static function highlightString(string $string) : string
     {
         $search  = array("\r\n", "\n\r", "\r", "\n", '<code>', '</code>', '<span style="color: #0000BB">&lt;?php&nbsp;', '#$@r4!/*');
         $replace = array('', '', '', '', '', '', '<span style="color: #0000BB">', '/*');
@@ -136,11 +135,10 @@ protected static function highlightString($string)
     /**
      * Modifies the backtrace array.
      *
-     * @access  protected
      * @param  array $backtrace Array returned by the getTrace() method of an exception object
      * @return array
      */
-    protected static function formatBacktrace($backtrace)
+    protected static function formatBacktrace(array $backtrace) : array
     {
         if (is_array($backtrace) === false || count($backtrace) === 0) {
             return $backtrace;
@@ -223,7 +221,7 @@ public static function fatal()
         $e = error_get_last();
 
         if ($e !== null && (error_reporting() & $e['type']) !== 0) {
-            ErrorHandler::exception(new ErrorException($e['message'], $e['type'], 0, $e['file'], $e['line']));
+            ErrorHandler::exception(new \ErrorException($e['message'], $e['type'], 0, $e['file'], $e['line']));
 
             exit(1);
         }
@@ -232,11 +230,10 @@ public static function fatal()
     /**
      * Writes message to log.
      *
-     * @access  public
      * @param  string  $message The message to write to the log
-     * @return boolean
+     * @return bool
      */
-    public static function writeLogs($message)
+    public static function writeLogs(string $message) : bool
     {
         return (bool) file_put_contents(rtrim(LOGS_PATH, '/') . '/' . gmdate('Y_m_d') . '.log',
                                         '[' . gmdate('d-M-Y H:i:s') . '] ' . $message . PHP_EOL,
@@ -246,7 +243,6 @@ public static function writeLogs($message)
     /**
      * Handles uncaught exceptions and returns a pretty error screen.
      *
-     * @access  public
      * @param Exception $exception An exception object
      */
     public static function exception($exception)
@@ -263,7 +259,7 @@ public static function exception($exception)
             $error['line']    = $exception->getLine();
 
             // Determine error type
-            if ($exception instanceof ErrorException) {
+            if ($exception instanceof \ErrorException) {
                 $error['type'] = 'ErrorException: ';
                 $error['type'] .= in_array($error['code'], array_keys(ErrorHandler::$levels)) ? ErrorHandler::$levels[$error['code']] : 'Unknown Error';
             } else {
@@ -280,7 +276,7 @@ public static function exception($exception)
 
                 $error['backtrace'] = $exception->getTrace();
 
-                if ($exception instanceof ErrorException) {
+                if ($exception instanceof \ErrorException) {
                     $error['backtrace'] = array_slice($error['backtrace'], 1); //Remove call to error handler from backtrace
                 }
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Force
+Copyright (c) 2018 Flextype Component
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1 +1,45 @@
-# ErrorHandler
+# Error Handler Component
+![version](https://img.shields.io/badge/version-1.0.4-brightgreen.svg?style=flat-square "Version")
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/flextype-components/errorhandler/blob/master/LICENSE)
+
+Error Handler Component for errors handling.
+
+### Installation
+
+```
+composer require flextype-components/errorhandler
+```
+
+### Usage
+
+```php
+use Flextype\Component\ErrorHandler\ErrorHandler;
+```
+
+Set error reporting level
+```php
+$show_errors = true;
+
+if ($show_errors) {
+    define('DEVELOPMENT', true);
+    error_reporting(-1);
+} else {
+    define('DEVELOPMENT', false);
+    error_reporting(0);
+}
+```
+
+Set LOGS_PATH constant
+```php
+define('LOGS_PATH', 'path/to/logs');
+```
+
+Set Error handler
+```php
+set_error_handler('Flextype\Component\ErrorHandler\ErrorHandler::error');
+register_shutdown_function('Flextype\Component\ErrorHandler\ErrorHandler::fatal');
+set_exception_handler('Flextype\Component\ErrorHandler\ErrorHandler::exception');
+```
+
+## License
+See [LICENSE](https://github.com/flextype-components/errorhandler/blob/master/LICENSE)

Resources/Views/Errors/exception.php

@@ -108,7 +108,7 @@
 
     <div class="error">
     <?php echo $error['type']; ?><?php if(isset($error['code'])): ?> <span style="color:#e1e1e1;padding:0px">[<?php echo $error['code']; ?>]</span><?php endif; ?>
-    <span class="pull-right">Gelato</span>
+    <span class="pull-right">Error Handler</span>
     </div>
     <div class="body">
     <strong>Message:</strong> <?php echo htmlspecialchars($error['message'], ENT_COMPAT, 'UTF-8', false); ?>
@@ -276,10 +276,6 @@
     <?php endforeach; ?>
     </table>
     </div>
-    <div style="padding-top:20px;padding-bottom:20px; padding-left:10px;">
-        <a href="http://monstra.org">MONSTRA</a>
-        <a href="http://gelato.monstra.org">GELATO</a>
-    </div>
 </div>
 
 <script type="text/javascript">

Resources/Views/Errors/production.php

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 <meta charset="utf-8">
-<title>Error</title>
+<title>Error Handler</title>
 <style type="text/css">
 body {
     height:100%;

composer.json

@@ -4,7 +4,7 @@
   "type": "library",
   "license": "MIT",
   "homepage": "https://github.com/flextype-components/errorhandler",
-  "description": "",
+  "description": "Error Handler Component for errors handling.",
   "authors": [
     {
         "name": "Sergey Romanenko",