diff --git a/.gitignore b/.gitignore index 2659611..d8a7996 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ composer.lock +vendor/ diff --git a/README.md b/README.md index 0f4c37f..372dc9c 100644 --- a/README.md +++ b/README.md @@ -11,15 +11,16 @@ PHP errors Catcher module for [Hawk.so](https://hawk.so) Use [composer](https://getcomposer.org) to install Catcher ```bash -composer require codex-team/hawk.php:* +$ composer require codex-team/hawk.php +$ composer install ``` #### Download and require php file -You can download `hawk.php` file from this repository and require it in your project. +You can download this repository and require `Hawk.php` file in your project. ```php -require 'hawk.php'; +require './hawk.php/src/Hawk.php'; ``` ### Add namespaces @@ -27,7 +28,7 @@ require 'hawk.php'; Add this line at the top of your PHP script. [Why?](http://php.net/manual/en/language.namespaces.importing.php) ```php -use \Hawk\HawkErrorManager; +use \Hawk\HawkCatcher; ``` ### Enable Catcher @@ -35,7 +36,7 @@ use \Hawk\HawkErrorManager; Create an instance and pass project token. ```php -HawkErrorManager::instance('abcd1234-1234-abcd-1234-123456abcdef'); +HawkCatcher::instance('abcd1234-1234-abcd-1234-123456abcdef'); ``` #### Custom Hawk server @@ -43,7 +44,7 @@ HawkErrorManager::instance('abcd1234-1234-abcd-1234-123456abcdef'); If you want to use custom Hawk server then pass a url to this catcher. ```php -HawkErrorManager::instance( +HawkCatcher::instance( 'abcd1234-1234-abcd-1234-123456abcdef', 'http://myownhawk.com/catcher/php' ); diff --git a/composer.json b/composer.json index 667fa31..8654fcc 100644 --- a/composer.json +++ b/composer.json @@ -7,6 +7,9 @@ "php": ">=5.6" }, "autoload": { - "psr-4": {"Hawk\\": "hawk"} + "classmap": [ + "src/Hawk.php" + ], + "psr-4": {"Hawk\\": "src/"} } } diff --git a/Hawk/hawk.php b/src/Hawk.php similarity index 86% rename from Hawk/hawk.php rename to src/Hawk.php index 0a4b8a5..2ca186b 100644 --- a/Hawk/hawk.php +++ b/src/Hawk.php @@ -1,5 +1,6 @@ use \Hawk\HawkErrorManager; + * > use \Hawk\HawkCatcher; * * Initialize Hawk this way - * > HawkErrorManager::instance('abcd1234-1234-abcd-1234-123456abcdef'); + * > HawkCatcher::instance('abcd1234-1234-abcd-1234-123456abcdef'); * * Or this way if you want to use custom Hawk server - * > HawkErrorManager::instance( + * > HawkCatcher::instance( * > 'abcd1234-1234-abcd-1234-123456abcdef', * > 'http://myownhawk.coms/catcher/php' * > ); * */ -class HawkErrorManager +class HawkCatcher { /** * Define error handlers @@ -29,9 +30,9 @@ class HawkErrorManager private function __construct ($accessToken) { self::$_accessToken = $accessToken; - register_shutdown_function(array('\Hawk\HawkErrorManager', 'checkForFatal')); - set_error_handler(array('\Hawk\HawkErrorManager', 'Log'), E_ALL); - set_exception_handler(array('\Hawk\HawkErrorManager', 'LogException')); + register_shutdown_function(array('\Hawk\HawkCatcher', 'checkForFatal')); + set_error_handler(array('\Hawk\HawkCatcher', 'Log'), E_ALL); + set_exception_handler(array('\Hawk\HawkCatcher', 'LogException')); error_reporting(E_ALL | E_STRICT); } @@ -41,7 +42,7 @@ private function __construct ($accessToken) { private static $_instance; /** - * Set private functions cause Singleton + * Set private functions cause Singleton */ private function __clone () {} private function __sleep () {}