|
| 1 | +# PHP Logger library |
| 2 | + |
| 3 | +[](https://packagist.org/packages/josantonius/logger) [](https://packagist.org/packages/josantonius/logger) [](https://packagist.org/packages/josantonius/logger) [](https://packagist.org/packages/josantonius/logger) |
| 4 | + |
| 5 | +[Spanish version](README-ES.md) |
| 6 | + |
| 7 | +Librería php para crear logs fácilmente y almacenarlos en formato Json. |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +- [Instalación](#instalación) |
| 12 | +- [Requisitos](#requisitos) |
| 13 | +- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos) |
| 14 | +- [Métodos disponibles](#métodos-disponibles) |
| 15 | +- [Uso](#uso) |
| 16 | +- [Tests](#tests) |
| 17 | +- [Manejador de excepciones](#manejador-de-excepciones) |
| 18 | +- [Contribuir](#contribuir) |
| 19 | +- [Repositorio](#repositorio) |
| 20 | +- [Licencia](#licencia) |
| 21 | +- [Copyright](#copyright) |
| 22 | + |
| 23 | +--- |
| 24 | + |
| 25 | +### Instalación |
| 26 | + |
| 27 | +La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/). |
| 28 | + |
| 29 | +Para instalar PHP Logger library, simplemente escribe: |
| 30 | + |
| 31 | + $ composer require Josantonius/Logger |
| 32 | + |
| 33 | +El comando anterior solamente instalará los archivos necesarios, si prefieres descargar todo el código, incluyendo tests, puedes utilizar: |
| 34 | + |
| 35 | + $ composer require Josantonius/Logger --prefer-source |
| 36 | + |
| 37 | +También puedes clonar el repositorio completo con Git: |
| 38 | + |
| 39 | + $ git clone https://github.com/Josantonius/PHP-Logger.git |
| 40 | + |
| 41 | +### Requisitos |
| 42 | + |
| 43 | +Esta ĺibrería es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores. |
| 44 | + |
| 45 | +### Cómo empezar y ejemplos |
| 46 | + |
| 47 | +Para utilizar esta librería, simplemente: |
| 48 | + |
| 49 | +```php |
| 50 | +require __DIR__ . '/vendor/autoload.php'; |
| 51 | + |
| 52 | +use Josantonius\Logger\Logger; |
| 53 | +``` |
| 54 | +### Métodos disponibles |
| 55 | + |
| 56 | +Métodos disponibles en esta librería: |
| 57 | + |
| 58 | +```php |
| 59 | +Logger::save(); |
| 60 | +Logger::storeLogs(); |
| 61 | +Logger->shutdown(); |
| 62 | +``` |
| 63 | +### Uso |
| 64 | + |
| 65 | +Ejemplo de uso para esta librería: |
| 66 | + |
| 67 | +```php |
| 68 | +<?php |
| 69 | +require __DIR__ . '/vendor/autoload.php'; |
| 70 | + |
| 71 | +use Josantonius\Logger\Logger; |
| 72 | + |
| 73 | +new Logger(); |
| 74 | + |
| 75 | +Logger::save('JOIN', 800, 100, 'Your message here', __LINE__, __FILE__); |
| 76 | +Logger::save('INFO', 801, 200, 'Your message here', __LINE__, __FILE__); |
| 77 | +Logger::save('WARNING', 802, 300, 'Your message here', __LINE__, __FILE__); |
| 78 | +Logger::save('ERROR', 803, 400, 'Your message here', __LINE__, __FILE__); |
| 79 | +Logger::save('FATAL', 804, 500, 'Your message here', __LINE__, __FILE__); |
| 80 | + |
| 81 | +Logger::storeLogs(); |
| 82 | + |
| 83 | +echo '<pre>'; var_dump(Logger::$logs); echo '</pre>'; |
| 84 | + |
| 85 | +/* |
| 86 | +array(1) { |
| 87 | + [0]=> |
| 88 | + array(14) { |
| 89 | + ["ip"]=> |
| 90 | + string(3) "158.54.12.100" |
| 91 | + ["uri"]=> |
| 92 | + string(5) "/folder/" |
| 93 | + ["referer"]=> |
| 94 | + string(7) "http://www.referer.es/" |
| 95 | + ["remote-port"]=> |
| 96 | + int(47290) |
| 97 | + ["ip-server"]=> |
| 98 | + string(3) "188.254.112.200" |
| 99 | + ["user-agent"]=> |
| 100 | + string(133) "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/5.36 (KHTML, like Gecko) Ubuntu Chromium/55.0.23.87 Chrome/55.0.23.87 Safari/5.36" |
| 101 | + ["type"]=> |
| 102 | + string(4) "join" |
| 103 | + ["state"]=> |
| 104 | + int(800) |
| 105 | + ["code"]=> |
| 106 | + string(3) "100" |
| 107 | + ["message"]=> |
| 108 | + string(17) "Visit the page" |
| 109 | + ["line"]=> |
| 110 | + int(572) |
| 111 | + ["file"]=> |
| 112 | + string(44) "/var/www/localhost/public_html/folder/index.php" |
| 113 | + ["hour"]=> |
| 114 | + string(8) "20:58:18" |
| 115 | + ["date"]=> |
| 116 | + string(10) "2017-01-21" |
| 117 | + } |
| 118 | +} |
| 119 | +*/ |
| 120 | +``` |
| 121 | + |
| 122 | +### Tests |
| 123 | + |
| 124 | +Para utilizar la clase de [pruebas](tests), simplemente: |
| 125 | + |
| 126 | +```php |
| 127 | +<?php |
| 128 | +$loader = require __DIR__ . '/vendor/autoload.php'; |
| 129 | + |
| 130 | +$loader->addPsr4('Josantonius\\Logger\\Tests\\', __DIR__ . '/vendor/josantonius/logger/tests'); |
| 131 | + |
| 132 | +use Josantonius\Logger\Tests\LoggerTest; |
| 133 | +``` |
| 134 | +Métodos de prueba disponibles en esta librería: |
| 135 | + |
| 136 | +```php |
| 137 | +LoggerTest->testSaveLog(); |
| 138 | +LoggerTest->testSaveLogWithFilepath(); |
| 139 | +LoggerTest->testSaveLogWithLimitLogsNumber(); |
| 140 | +LoggerTest->testSaveLogWithUserIP(); |
| 141 | +LoggerTest->testSaveLogWithUserCustomStates(); |
| 142 | +LoggerTest->testSaveLogWithUserCustomParams(); |
| 143 | +LoggerTest->testDisableLogs(); |
| 144 | +LoggerTest->testDisableLogsByState(); |
| 145 | +LoggerTest->testGetLogs(); |
| 146 | +LoggerTest->testGetLogsFromCustomPath(); |
| 147 | +LoggerTest->testExceptionCouldCreatePath(); |
| 148 | +``` |
| 149 | + |
| 150 | +### Manejador de excepciones |
| 151 | + |
| 152 | +Esta librería utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto. |
| 153 | +### Contribuir |
| 154 | +1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función. |
| 155 | +1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste. |
| 156 | +1. Escribe una o más pruebas para la nueva característica o expón el error. |
| 157 | +1. Haz cambios en el código para implementar la característica o reparar el fallo. |
| 158 | +1. Envía pull request para fusionar los cambios y que sean publicados. |
| 159 | + |
| 160 | +Esto está pensado para proyectos grandes y de larga duración. |
| 161 | + |
| 162 | +### Repositorio |
| 163 | + |
| 164 | +Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit). |
| 165 | + |
| 166 | +### Licencia |
| 167 | + |
| 168 | +Este proyecto está licenciado bajo **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información. |
| 169 | + |
| 170 | +## Copyright |
| 171 | + |
| 172 | +2017 Josantonius, [josantonius.com](https://josantonius.com/) |
| 173 | + |
| 174 | +Si te ha resultado útil, házmelo saber :wink: |
| 175 | + |
| 176 | +Puedes contactarme en [Twitter ](https://twitter.com/Josantonius) o a través de mi [correo electrónico ](mailto:[email protected]). |
0 commit comments