README

Logger

O Logger é uma classe PHP para registrar logs em arquivos e exibir mensagens no terminal.

Funcionalidades

Espaços no nome do arquivo serão alterados para underscores "_".
Ao instanciar a classe, é possível passar um array de configuração (opcional) com os seguintes elementos:
- path: Caminho onde os arquivos serão salvos. Se não for informado, o padrão é ./logs.
- nameFile: Nome dos arquivos. Se não for informado, o padrão é log_%d[Ymd].log.
- messageFormat: Formato da mensagem que será gravada no arquivo. Se não for informado, o padrão é [%d[d/m/Y H:i:s]] [%u]] [%t] %m %.
  - %d: Data atual em formato Y-m-d [Y-m-d H:i:s], seguindo o padrão do formato da função date.
    - %d[format]: Data atual com o formato especificado.
  - %u: Identificador único gerado a cada requisição do Logger.
  - %t: Tipo do log, podendo ser INFO, ERROR, etc. Se nenhum for enviado, será considerado como INFO.

Chamada da Função

$logger = Logger::start($configuracao); //$configuração é um campo opcional
$logger->log("Mensagem Teste", 2); // Será gerado um arquivo de acordo com as configurações
$logger->printToTerminal("Mensagem Teste", 1); // Irá exibir no terminal

Exemplo de Utilização:

// Exemplo de utilização do Logger
$configuracao = [
    'path' => '/caminho/do/logs',
    'nameFile' => 'meu_log_%d[Ymd].log',
    'messageFormat' => '[%d[d/m/Y H:i:s]] [%t] %m %u'
];

$logger = Logger::start($configuracao);
$logger->log("Mensagem de teste", 2);  // pode ser utilizado tambem a string "error" $logger->log("Mensagem de teste", "error");

Configurações Padrão

Se as configurações não forem fornecidas ao instanciar a classe, valores padrão serão utilizados para o caminho do arquivo de log, nome do arquivo e formato da mensagem.

Formatação da Data

É possível formatar a data conforme desejado pelo usuário, usando o marcador %d[format]. Exemplos:

$d[y] - ano com dois digitos
$d[Y] - ano completo
$d[m] - mês com dois dígitos
$d[M] - mês completo
$d[d] - dia com dois dígitos
$d[Ymd] - data no formato AAAAMMDD
$d[Y-m-d H:i:s] - Data e hora no formato AAAA-MM-DD HH:mm:ss

Tipos de Logs

A mensagem na chamada da função log() e printToTerminal() podem ser do tipo string, inteiro, float, array, boolean

boollen true será mostrado 1 e boolean false será vazio

O tipo de log é opcional na chamada da função log() e printToTerminal().. Caso não seja informado, ele assume que é um LOG INFO. Os tipos de logs suportados são: INFO, DEBUG, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY.

Padrão Singleton

O Logger foi desenvolvido seguindo o padrão de projeto Singleton. Isso garante que apenas uma instância da classe seja criada durante a execução do programa, o que pode trazer as seguintes vantagens:

Economia de memória: Apenas uma instância da classe é mantida em memória, mesmo que seja acessada várias vezes.
Controle de acesso global: O acesso à instância única do Logger é facilitado em todo o código, garantindo consistência e evitando problemas de concorrência.
Facilidade de manutenção: O Singleton promove um design claro e conciso, facilitando a manutenção e a compreensão do código.

ivanrufino / logger

Maintainers

Details