README

Sistema para el registro de información en flujos de salida.

Instalación

Control de versiones

Este proyecto puede ser descargado usando git. Para ello se debe ejecutar en una consola:

git clone https://www.gitlab.com/jfphp/log.git
cd log

Composer

Este proyecto usa como gestor de dependencias Composer el cual puede ser instalado siguiendo las instrucciones especificadas en la documentación oficial del proyecto.

Para instalar el paquete jf/log usando este manejador de paquetes se debe ejecutar:

composer require jf/log

Dependencias

Cuando el proyecto es instalado, adicionalmente se instalan las siguientes dependencias:

Paquete	Versión
jf/base	^5.0
psr/log	^3.0

Archivos

Clases

Nombre	Descripción
📖 jf\Log\Assert	Aserciones del paquete `jf\Log`.
📖 jf\Log\Filter\ContextKey	Filtra aquellas trazas en las que el contexto contiene una clave con el valor especificado.
📖 jf\Log\Filter\Cookie	Filtra la escritura de la traza si hay una cookie asignada con el nombre especificado.
📖 jf\Log\Formatter\Color	Formateador a usar para colorear las entradas del registro.
📖 jf\Log\Formatter\Formatter	Formateador a usar para convertir los diferentes tipos de datos en texto.
📖 jf\Log\Formatter\Plain	Formateador a usar para convertir los diferentes tipos de datos en texto.
📖 jf\Log\Logger\Logger	Logger que permite filtrar mensajes así como que cada clase hija obtenga un logger propio si se usa como un singleton.
📖 jf\Log\Logger\Plain	Logger para mostrar textos planos sin decorar.
📖 jf\Log\Logger\Time	Logger simple usado para mostrar por consola la hora al inicio de cada mensaje y que además permite colorearlos según el nivel y el tipo de dato a mostrar.
📖 jf\Log\Writer\AWriter	Clase base para los flujos de salida sencillos.
📖 jf\Log\Writer\File	Clase para manejar el flujo de salida usando un archivo.
📖 jf\Log\Writer\Output	Clase para manejar el flujo de salida enviado al navegador.
📖 jf\Log\Writer\StdErr	Clase para manejar el flujo de salida por la salida de errores.
📖 jf\Log\Writer\StdOut	Clase para manejar el flujo de salida por la salida estándar.

Interfaces

Nombre	Descripción
📖 jf\Log\Filter\IFilter	Interfaz para las clases que permiten filtrar las trazas que se escriben.
📖 jf\Log\Formatter\IFormatter	Interfaz para los formateadores a usar que convertirán los diferentes tipos de datos en texto.
📖 jf\Log\Interface\ILevel	Interfaz para gestionar el nivel de los mensajes.
📖 jf\Log\Interface\ILogger	Interfaz para gestionar el gestor del registro.
📖 jf\Log\Writer\IWriter	Interfaz para gestionar el flujo de salida.

Traits

Nombre	Descripción
📖 jf\Log\Trait\TLevel	Gestiona el nivel de los mensajes.
📖 jf\Log\Trait\TLogFilename	Agrega a una clase un logger que usa un archivo para registrar los mensajes.
📖 jf\Log\Trait\TLogger	Gestiona el gestor del registro.

Diagrama

Generado con ❤️ usando jfGeneratorDoc 0.1.0

jf / log

Package info

Security

Statistics