php logger

biblioteca php logger

versión en español

Biblioteca PHP para crear registros fácilmente y almacenarlos en formato Json.

---

• Requisitos
• Instalación
• Métodos disponibles
• Inicio rápido
• Métodos disponibles
• Uso
• Pruebas
• Patrocinador
• Licencia

---

Requisitos

Esta biblioteca es compatible con las versiones PHP 5.6 o superiores y es compatible con las versiones HHVM 3.0 o superiores.

Instalación

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

Para instalar la biblioteca php logger , simplemente:

 composer require Josantonius/Logger

El comando anterior solo instalará los archivos necesarios, si prefieres descargar el código fuente completo puedes usar:

 composer require Josantonius/Logger --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clon 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:

- Iniciador para la gestión de depuración del sitio.

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

atributo	Descripción	Tipo	Requerido	Por defecto
$ruta	Nombre de ruta para guardar el archivo con registros.	cadena	No	nulo
$nombre de archivo	Nombre del archivo JSON que guardará los registros.	cadena	No	nulo
$ número de registro	Número máximo de registros para guardar en un archivo.	entero	No	200
$ip	Si quieres ir a otra biblioteca.	cadena	No	nulo
$estados	Diferentes estados para registros.	formación	No	nulo

# Devolución (nula)

- Guardar línea de registro

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

atributo	Descripción	Tipo	Requerido	Por defecto
$tipo	Tipo de error o advertencia.	cadena	Sí
$código	Código de estado de respuesta HTTP.	entero	Sí
$mensaje	Mensaje.	cadena	Sí
línea $	Línea desde la que se ejecuta el guardado.	entero	Sí
$archivo	Ruta de archivo desde la que se llama al método.	cadena	Sí
$datos	Parámetros personalizados adicionales.	formación	No	0

# Retorno (booleano)

- Guardar registros en un archivo Json

Logger:: store ();

# Retorno (booleano)

- Obtener registros guardados

Logger:: get ();

# Retorno (matriz) → registros guardados

- Definir directorio para scripts y obtener URL del archivo

Logger:: script ( $ url );

atributo	Descripción	Tipo	Requerido	Por defecto
$url	URL del archivo.	cadena	Sí

# Retorno (cadena) → URL del archivo

- Definir directorio para estilos y obtener URL del archivo

Logger:: style ( $ url );

atributo	Descripción	Tipo	Requerido	Por defecto
$url	URL del archivo.	cadena	Sí

# Retorno (cadena) → URL del archivo

- Obtener la cantidad de registros agregados en la sección actual

Logger:: added ();

# Retorno (int) → registros agregados en la sección actual

- Mostrar sección del registrador

Logger:: render ();

# Retorno (booleano verdadero)

- Restablecer parámetros

Logger:: reset ();

# Retorno (booleano verdadero)

Inicio rápido

Para usar esta biblioteca con Composer :

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

use Josantonius  Logger  Logger ;

O si lo instaló manualmente , úselo:

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

use Josantonius  Logger  Logger ;

Uso

Ejemplo de uso de 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 ();

Pruebas

Para ejecutar pruebas solo necesitas Composer y ejecutar lo siguiente:

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

cd PHP-Logger

composer install

Ejecute pruebas unitarias con PHPUnit:

 composer phpunit

Ejecute pruebas estándar del código PSR2 con PHPCS:

 composer phpcs

Ejecute pruebas de PHP Mess Detector para detectar inconsistencias en el estilo del código:

 composer phpmd

Ejecute todas las pruebas anteriores:

 composer tests

Patrocinador

Si este proyecto le ayuda a reducir su tiempo de desarrollo, ¿puede patrocinarme para respaldar mi trabajo de código abierto?

Licencia

Este repositorio tiene la licencia MIT.

Copyright © 2017-2022, Josantonio