Logger
in package
Clase para manejar mensajes generados en la aplicación de forma "silenciosa" y luego poder recuperarlos para procesar en la aplicación.
Los mensajes estarán disponibles solo durante la ejecución del script PHP. Una vez termina, los mensajes se pierden. Es importante recuperarlos antes de que termine la ejecución de la página si se desea hacer algo con ellos.
Table of Contents
Properties
- $logStorage : array<string|int, mixed>
- Almacenamiento en memoria para los logs.
- $useBacktrace : bool
- Define si se usa o no backtrace.
Methods
- clearAllLogs() : void
- Limpia todos los logs almacenados.
- clearLogs() : void
- Limpia los logs de un nivel específico.
- debug() : void
- Registra un mensaje de nivel DEBUG en el log.
- enableBacktrace() : void
- Activa o desactiva el backtrace para los mensajes que se escribirán en la bitácora.
- error() : void
- Registra un mensaje de nivel ERROR en el log.
- flushLogs() : array<string|int, mixed>
- Recupera y limpia los logs de un nivel de severidad específico.
- getAllLogs() : array<string|int, LogMessage>
- Recupera todos los logs almacenados.
- getLogs() : array<string|int, LogMessage>
- Recupera los logs de un nivel específico.
- info() : void
- Registra un mensaje de nivel INFO en el log.
- warning() : void
- Registra un mensaje de nivel WARNING en el log.
- log() : void
- Registra un mensaje en el log.
Properties
$logStorage
Almacenamiento en memoria para los logs.
private
array<string|int, mixed>
$logStorage
= []
$useBacktrace
Define si se usa o no backtrace.
private
bool
$useBacktrace
= false
Methods
clearAllLogs()
Limpia todos los logs almacenados.
public
clearAllLogs() : void
clearLogs()
Limpia los logs de un nivel específico.
public
clearLogs(int $level) : void
Parameters
- $level : int
-
Nivel de severidad de los logs que se desean limpiar.
debug()
Registra un mensaje de nivel DEBUG en el log.
public
debug(string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
- $message : string
-
El mensaje que se desea registrar.
- $context : array<string|int, mixed> = []
-
Contexto adicional para el mensaje.
enableBacktrace()
Activa o desactiva el backtrace para los mensajes que se escribirán en la bitácora.
public
enableBacktrace([bool $backtrace = true ]) : void
Parameters
- $backtrace : bool = true
-
Define si se activa o no el backtrace.
error()
Registra un mensaje de nivel ERROR en el log.
public
error(string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
- $message : string
-
El mensaje que se desea registrar.
- $context : array<string|int, mixed> = []
-
Contexto adicional para el mensaje.
flushLogs()
Recupera y limpia los logs de un nivel de severidad específico.
public
flushLogs([int $severity = LOG_ERR ][, bool $newFirst = true ]) : array<string|int, mixed>
Este método permite recuperar todos los mensajes de log de un nivel de severidad determinado y, después de recuperarlos, los elimina de la memoria. Los mensajes se pueden ordenar de modo que los más recientes aparezcan primero.
Parameters
- $severity : int = LOG_ERR
-
Nivel de severidad de los logs que se desean recuperar. Por defecto es LOG_ERR.
- $newFirst : bool = true
-
Indica si los logs deben ser ordenados con los más nuevos primero. Por defecto es true.
Return values
array<string|int, mixed> —Arreglo con los mensajes de log recuperados del nivel de severidad especificado. Si no hay logs, se devuelve un arreglo vacío.
getAllLogs()
Recupera todos los logs almacenados.
public
getAllLogs([bool $newFirst = true ]) : array<string|int, LogMessage>
Parameters
- $newFirst : bool = true
-
Indica si los logs deben ordenarse de nuevo primero.
Return values
array<string|int, LogMessage> —Arreglo con todos los logs.
getLogs()
Recupera los logs de un nivel específico.
public
getLogs(int $level) : array<string|int, LogMessage>
Parameters
- $level : int
-
Nivel de severidad de los logs que se desean recuperar.
Return values
array<string|int, LogMessage> —Arreglo con los logs del nivel especificado.
info()
Registra un mensaje de nivel INFO en el log.
public
info(string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
- $message : string
-
El mensaje que se desea registrar.
- $context : array<string|int, mixed> = []
-
Contexto adicional para el mensaje.
warning()
Registra un mensaje de nivel WARNING en el log.
public
warning(string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
- $message : string
-
El mensaje que se desea registrar.
- $context : array<string|int, mixed> = []
-
Contexto adicional para el mensaje.
log()
Registra un mensaje en el log.
private
log(int $level, string $message[, array<string|int, mixed> $context = [] ]) : void
Parameters
- $level : int
-
Nivel de severidad del log.
- $message : string
-
El mensaje que se desea registrar.
- $context : array<string|int, mixed> = []
-
Contexto adicional para el mensaje.