php logger

biblioteca php logger

Versão espanhola

Biblioteca PHP para criar logs facilmente e armazená-los no formato Json.

---

• Requisitos
• Instalação
• Métodos Disponíveis
• Início rápido
• Métodos Disponíveis
• Uso
• Testes
• Patrocinador
• Licença

---

Requisitos

Esta biblioteca é suportada por PHP versões 5.6 ou superior e é compatível com HHVM versões 3.0 ou superior.

Instalação

A forma preferida de instalar esta extensão é através do Composer.

Para instalar a biblioteca php logger , simplesmente:

 composer require Josantonius/Logger

O comando anterior irá instalar apenas os arquivos necessários, caso prefira baixar todo o código fonte você pode usar:

 composer require Josantonius/Logger --prefer-source

Você também pode clonar o repositório completo com Git:

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

Ou instale-o manualmente :

Baixe Logger.php:

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

Baixe Json.php:

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

Imagens

Métodos Disponíveis

Métodos disponíveis nesta biblioteca:

- Iniciador para gerenciamento de depuração de site

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

Atributo	Descrição	Tipo	Obrigatório	Padrão
$caminho	Nome do caminho para salvar o arquivo com logs.	corda	Não	nulo
$nome do arquivo	Nome do arquivo JSON que salvará os logs.	corda	Não	nulo
$logNumber	Número máximo de logs para salvar em arquivo.	interno	Não	200
$ip	Se você quiser ir para outra biblioteca.	corda	Não	nulo
$ estados	Diferentes estados para logs.	variedade	Não	nulo

# Retorno (vazio)

- Salvar linha de registro

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

Atributo	Descrição	Tipo	Obrigatório	Padrão
$tipo	Tipo de erro ou aviso.	corda	Sim
$código	Código de status de resposta HTTP.	interno	Sim
$ mensagem	Mensagem.	corda	Sim
$ linha	Linha a partir da qual o salvamento é executado.	interno	Sim
$arquivo	Caminho do arquivo a partir do qual o método é chamado.	corda	Sim
$dados	Parâmetros personalizados extras.	variedade	Não	0

# Retorno (booleano)

- Salvar logs em arquivo Json

Logger:: store ();

# Retorno (booleano)

- Obtenha registros salvos

Logger:: get ();

# Return (array) → logs salvos

- Definir diretório para scripts e obter URL do arquivo

Logger:: script ( $ url );

Atributo	Descrição	Tipo	Obrigatório	Padrão
$url	URL do arquivo.	corda	Sim

# Retorno (string) → URL do arquivo

- Defina o diretório para estilos e obtenha o URL do arquivo

Logger:: style ( $ url );

Atributo	Descrição	Tipo	Obrigatório	Padrão
$url	URL do arquivo.	corda	Sim

# Retorno (string) → URL do arquivo

- Obtenha o número de logs adicionados na seção atual

Logger:: added ();

# Return (int) → logs adicionados na seção atual

- Exibir seção do registrador

Logger:: render ();

# Retorno (booleano verdadeiro)

- Redefinir parâmetros

Logger:: reset ();

# Retorno (booleano verdadeiro)

Início rápido

Para usar esta biblioteca com o Composer :

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

use Josantonius  Logger  Logger ;

Ou se você instalou manualmente , use-o:

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

use Josantonius  Logger  Logger ;

Uso

Exemplo de uso para esta biblioteca:

- Exemplo 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 ();

- Exemplo avançado

 <?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 ();

Testes

Para rodar testes você só precisa do compositor e executar o seguinte:

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

cd PHP-Logger

composer install

Execute testes unitários com PHPUnit:

 composer phpunit

Execute testes padrão de código PSR2 com PHPCS:

 composer phpcs

Execute testes do PHP Mess Detector para detectar inconsistências no estilo do código:

 composer phpmd

Execute todos os testes anteriores:

 composer tests

Patrocinador

Se este projeto ajudar você a reduzir seu tempo de desenvolvimento, você pode me patrocinar para apoiar meu trabalho de código aberto?

Licença

Este repositório está licenciado sob a licença MIT.

Copyright © 2017-2022, Josantonius