josantonius / logger
1.1.6
2022-08-18 11:21 UTC
Requires
- php: ^5.6 || ^7.0
- josantonius/json: ^1.1.5
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.3 || ^2.8
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^5.7 || ^6.0
- squizlabs/php_codesniffer: ^3.0
README
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
或 手动安装
wget https://raw.githubusercontent.com/Josantonius/PHP-Logger/master/src/Logger.php
wget https://raw.githubusercontent.com/Josantonius/PHP-Json/master/src/Json.php
图片
可用方法
此库中的可用方法
- 网站调试管理的启动器
new Logger($path, $filename, $logNumber, $ip, $states);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$path | 保存日志文件的路径名称。 | 字符串 | 否 | null |
$filename | 保存日志的 JSON 文件名。 | 字符串 | 否 | null |
$logNumber | 保存到文件中的最大日志数。 | 整型 | 否 | 200 |
$ip | 如果您想访问其他库。 | 字符串 | 否 | null |
$states | 日志的不同状态。 | 数组 | 否 | null |
返回 (void)
- 保存日志行
Logger::save($type, $code, $msg, $line, $file, $data);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$type | 错误类型或警告。 | 字符串 | 是 | |
$code | HTTP 响应状态码。 | 整型 | 是 | |
$message | 消息。 | 字符串 | 是 | |
$line | 执行保存的行。 | 整型 | 是 | |
$file | 调用此方法的路由。 | 字符串 | 是 | |
$data | 额外的自定义参数。 | 数组 | 否 | 0 |
返回 (boolean)
- 将日志保存到 JSON 文件
Logger::store();
返回 (boolean)
- 获取已保存日志
Logger::get();
返回 (array) → 已保存的日志
- 为脚本定义目录并从文件获取 URL
Logger::script($url);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$url | 文件 URL。 | 字符串 | 是 |
返回 (string) → 文件 URL
- 定义样式目录并从文件获取URL
Logger::style($url);
属性 | 描述 | 类型 | 必需 | 默认 |
---|---|---|---|---|
$url | 文件 URL。 | 字符串 | 是 |
返回 (string) → 文件 URL
- 获取当前部分中添加的日志数量
Logger::added();
返回 (int) → 当前部分中添加的日志数量
- 显示日志部分
Logger::render();
返回 (boolean true)
- 重置参数
Logger::reset();
返回 (boolean 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();
测试
要运行测试,您只需要composer并执行以下操作
git clone https://github.com/Josantonius/PHP-Logger.git
cd PHP-Logger
composer install
使用PHPUnit运行单元测试
composer phpunit
composer phpcs
使用PHP Mess Detector测试来检测代码风格的不一致性
composer phpmd
运行所有之前的测试
composer tests
赞助
如果这个项目帮助您减少了开发时间,您可以赞助我以支持我的开源工作 😊
许可
本存储库使用MIT许可证。
版权所有 © 2017-2022,Josantonius