ialopezg/logger

v0.0.4 2020-09-21 05:10 UTC

This package is auto-updated.

Last update: 2024-09-21 14:26:47 UTC


README

Total Downloads License

PHP日志服务。易于使用和自定义的日志服务。允许您在自定义路径或目录中写入日志文件,文件扩展名,日期格式,消息缩进和多个级别。

目录

要求

  • PHP 5.6+

安装

通过composer安装最新版本

composer require ialopezg/logger

使用说明

基本用法

首先,创建一个新的“Logger”实例。Logger旨在使配置库尽可能简单。

$logger = new \ialopezg\Services\Logger([
    'log_path' => 'logs'
]);

更多选项请参阅示例目录。

选项

这是在创建logger实例时可以传递的可能选项列表

  • enabled 如果logger可以写入日志文件。默认:true
  • log_date_format 日志日期格式。默认:Y-m-d H:i:s
  • log_file_extension 日志文件扩展名。默认:log
  • log_path: 日志文件写入的路径。如果未指定或不可写,将Logger::enabled属性修改为false
  • log_file_permissions 日志文件权限。默认:0644,所有者可读写,其他人只读。
  • log_indented 消息缩进。默认:true
  • log_threshold 日志阈值。默认:1error。接受单个值或值数组。接受单个或数组值。接受的值:errordebuginfowarningall

方法

方法详情

方法:log()
/**
 * Log a message into the default log system. If the log system does not exists, will create a new one.
 *
 * @param int $level log message level. Accepts: `debug`, `error`, `info` and `warning` messages.
 * @param string $message log message.
 *
 * @return bool <code>true</code> if line was successfully wrote, <code>false</code> otherwise.
 */
public static function log($level, $message): bool

示例

// debug message
Logger::log('debug', 'Debug message');
// error message
Logger::log('error', 'Error message');
// info message
Logger::log('info', 'Informative message');
// warning message
Logger::log('warning', 'Waring message');
方法:write()
/**
 * Write a log message line.
 *
 * @param string $level Error log level.
 * @param string $message Error log message.
 *
 * @return bool True if line was successfully wrote.
 */
public static function write($level, $message): void

示例

// debug message
$logger->write('debug', 'Debug message');
// error message
$logger->write('error', 'Error message');
// info message
$logger->write('info', 'Informative message');
// warning message
$logger->write('warning', 'Waring message');

许可证

此项目采用MIT许可证。更多信息请参阅LICENSE