PHP Logger library

Spanish version

Biblioteca php para crear logs fácilmente y almacenarlos en formato Json.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Métodos disponibles
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• Licencia
• Copyright

Requisitos

Esta clase es soportada por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

La mejor forma de instalar esta extensión es a través de Composer.

Para instalar PHP Logger library, simplemente escribe:

$ composer require Josantonius/Logger

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

$ composer require Josantonius/Logger --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/Josantonius/PHP-Logger.git

O instalarlo manualmente:

Descargar Logger.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Logger/master/src/Logger.php

Descargar Json.php:

$ wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php

Imágenes

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Iniciar manejo de logs en el sitio:

new Logger($path, $filename, $logNumber, $ip, $states);

Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $path | Ruta donde guardar los logs. | string | No | null | | $filename | Nombre de archivo JSON que guardará los registros. | string | No | null | | $logNumber | Número máximo de logs guardar en el archivo. | int | No | 200 | | $ip | IP del usuario. | string | No | null | | $states | Diferentes estados para los logs. | array | No | null |

# Return (void)

- Guardar log:

Logger::save($type, $code, $msg, $line, $file, $data);

Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $type | Tipo de error o aviso. | string | Yes | | | $code | Código de estado de respuesta HTTP. | int | Yes | | | $message | Mensaje. | string | Yes | | | $line | Línea desde la que se guarda el log. | int | Yes | | | $file | Ruta del archivo desde el que se llama el método. | string | Yes | | | $data | Parámetros extra personalizados. | array | No | 0 |

# Return (boolean)

- Guarda los registros en archivo JSON:

Logger::store();

# Return (boolean)

- Obtener logs guardados:

Logger::get();

# Return (array) ? logs guardados

- Definir directorio para scripts y obtener url del archivo:

Logger::script($url);

Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $url | Url del archivo. | string | Yes | |

# Return (string) ? url del archivo

- Definir directorio para estilos y obtener url del archivo:

Logger::style($url);

Atributo | Descripción | Tipo | Requerido | Predeterminado | --- | --- | --- | --- | --- | | $url | Url del archivo. | string | Yes | |

# Return (string) ? url del archivo

- Obtener el número de logs guardados en la sección actual:

::added();

# Return (int) ? logs añadidos en la sección actual

- Mostrar sección de registros

Logger::render();

# Return (boolean true)

- Restablecer parámetros:

Logger::reset();

# Return (boolean true)

Cómo empezar

Para utilizar esta biblioteca con Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/Logger.php';
require_once __DIR__ . '/Json.php';

use Josantonius\Logger\Logger;

Uso

Ejemplo de uso para esta biblioteca:

- Ejemplo básico

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

new Logger();

Logger::save('SUCCESS',  100, 'msg', __LINE__, __FILE__);
Logger::save('JOIN',     200, 'msg', __LINE__, __FILE__);
Logger::save('INFO',     300, 'msg', __LINE__, __FILE__);
Logger::save('WARNING',  400, 'msg', __LINE__, __FILE__);
Logger::save('ERROR',    500, 'msg', __LINE__, __FILE__);
Logger::save('FATAL',    600, 'msg', __LINE__, __FILE__);
Logger::save('REQUEST',  700, 'msg', __LINE__, __FILE__);
Logger::save('RESPONSE', 800, 'msg', __LINE__, __FILE__);

Logger::storeLogs();

- Ejemplo avanzado

<?php
require __DIR__ . '/vendor/autoload.php';

use Josantonius\Logger\Logger;

$states  = [

  'global'    => true,
  'exception' => true,
  'error'     => false,
  'notice'    => false,
  'fatal'     => true,
];

new Logger('/logger/', 'logs', 600, '58.80.84.44', $states);

Logger::save('EXCEPTION', 400, 'msg', __LINE__, __FILE__);
Logger::save('ERROR' ,    402, 'msg', __LINE__, __FILE__);
Logger::save('NOTICE',    100, 'msg', __LINE__, __FILE__);

$params = [

  'id-user'   => 68,
  'name-user' => 'Joe'
]; 
        
Logger::save('FATAL, 500, 'msg', __LINE__, __FILE__, $params);

Logger::storeLogs();

echo 'Logs added: ' . Logger::added();

echo 'Logs added: ' . count(Logger::get);

printf('<link href="%s">', Logger::style('http://site.com/public/css/'));

printf('<script src="%s">', Logger::script('http://site.com/public/js/'));

Logger::render();

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

$ git clone https://github.com/Josantonius/PHP-Logger.git

$ cd PHP-Logger

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código PSR2 con PHPCS:

$ composer phpcs

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

• [x] Completar tests
• [x] Mejorar la documentación

Contribuir

1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
2. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
3. Escribe una o más pruebas para la nueva característica o expón el error.
4. Haz cambios en el código para implementar la característica o reparar el fallo.
5. Envía pull request para fusionar los cambios y que sean publicados.

Esto está pensado para proyectos grandes y de larga duración.

Repositorio

Los archivos de este repositorio se crearon y subieron automáticamente con Reposgit Creator.

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2017 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.