php logger

библиотека php logger

Испанская версия

Библиотека PHP для простого создания журналов и их хранения в формате Json.

---

• Требования
• Установка
• Доступные методы
• Быстрый старт
• Доступные методы
• Использование
• Тесты
• Спонсор
• Лицензия

---

Требования

Эта библиотека поддерживается PHP версии 5.6 или выше и совместима с HHVM версии 3.0 или выше.

Установка

Предпочтительный способ установки этого расширения — через Composer.

Чтобы установить библиотеку php logger , просто:

 composer require Josantonius/Logger

Предыдущая команда установит только необходимые файлы, если вы предпочитаете загрузить весь исходный код, вы можете использовать:

 composer require Josantonius/Logger --prefer-source

Вы также можете клонировать весь репозиторий с помощью Git:

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

Или установите его вручную :

Загрузите Logger.php:

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

Загрузите Json.php:

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

Изображения

Доступные методы

Доступные методы в этой библиотеке:

- Инициатор управления отладкой сайта.

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

Атрибут	Описание	Тип	Необходимый	По умолчанию
$путь	Путь для сохранения файла с логами.	нить	Нет	нулевой
$имя_файла	Имя файла JSON, в котором будут сохраняться журналы.	нить	Нет	нулевой
$logNumber	Максимальное количество журналов для сохранения в файле.	интервал	Нет	200
$ip	Если вы хотите попасть в другую библиотеку.	нить	Нет	нулевой
$состояния	Разные состояния журналов.	множество	Нет	нулевой

# Возврат (недействительный)

- Сохранить строку журнала

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

Атрибут	Описание	Тип	Необходимый	По умолчанию
$тип	Тип ошибки или предупреждение.	нить	Да
$код	Код состояния ответа HTTP.	интервал	Да
$сообщение	Сообщение.	нить	Да
$строка	Строка, из которой выполняется сохранение.	интервал	Да
$файл	Путь к файлу, из которого вызывается метод.	нить	Да
$данные	Дополнительные пользовательские параметры.	множество	Нет	0

# Возврат (логическое значение)

- Сохранение журналов в файл Json.

Logger:: store ();

# Возврат (логическое значение)

- Получить сохраненные журналы

Logger:: get ();

# Возврат (массив) → логи сохранены

- Определить каталог для скриптов и получить URL-адрес из файла

Logger:: script ( $ url );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$url	URL-адрес файла.	нить	Да

# Возврат (строка) → URL файла

- Определите каталог для стилей и получите URL-адрес из файла

Logger:: style ( $ url );

Атрибут	Описание	Тип	Необходимый	По умолчанию
$url	URL-адрес файла.	нить	Да

# Возврат (строка) → URL файла

- Получить количество журналов, добавленных в текущий раздел.

Logger:: added ();

# Return (int) → логи добавлены в текущий раздел

- Отображение раздела журнала

Logger:: render ();

# Возврат (логическое значение true)

- Сбросить параметры

Logger:: reset ();

# Возврат (логическое значение true)

Быстрый старт

Чтобы использовать эту библиотеку с Composer :

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

use Josantonius  Logger  Logger ;

Или, если вы установили его вручную , используйте его:

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

use Josantonius  Logger  Logger ;

Использование

Пример использования этой библиотеки:

- Базовый пример

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

- Расширенный пример

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

Тесты

Для запуска тестов вам просто нужен композитор и выполните следующее:

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

cd PHP-Logger

composer install

Запустите модульные тесты с помощью PHPUnit:

 composer phpunit

Запустите стандартные тесты кода PSR2 с помощью PHPCS:

 composer phpcs

Запустите тесты PHP Mess Detector, чтобы обнаружить несоответствия в стиле кода:

 composer phpmd

Запустите все предыдущие тесты:

 composer tests

Спонсор

Если этот проект поможет вам сократить время разработки, вы можете спонсировать меня для поддержки моей работы с открытым исходным кодом?

Лицензия

Этот репозиторий лицензируется по лицензии MIT.

Copyright © 2017-2022, Джосантониус