README

PHP库，可以轻松创建日志并将它们存储为Json格式。

需求
安装
可用方法
快速开始
可用方法
使用方法
测试
赞助商
许可

需求

此库支持PHP版本5.6或更高版本，并与HHVM版本3.0或更高版本兼容。

安装

安装此扩展的首选方式是通过Composer。

要安装PHP日志库，只需

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

属性	描述	类型	必需	默认
$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

使用 PSR2 代码规范测试，使用 PHPCS

composer phpcs

运行 PHP Mess Detector 测试以检测代码风格中的不一致性

composer phpmd

运行所有之前的测试

composer tests

赞助商

如果这个项目帮助您减少了开发时间，您可以通过赞助我来支持我的开源工作 😊

许可证

此存储库受 MIT 许可证的许可。

josantonius / logger

维护者

详细信息