README

名称

Log\Buffered -

概述

use Log\Buffered;

require_once '/path/to/vendor/autoload.php';

$log = new Buffered(
    [
        'file'        => '/paht/to/myapp.log', // stderr by default
        'buffer_size' => 10240,                // 5120 bytes by default
    ]
);
$log->debugf('This is a %s message', 'debug'); // This message never be output
$log->infof('This is an %s message', 'info');
$log->warnf('This is a %s message', 'warn');
$log->critf('This is a %s message', 'crit');

安装

要将此软件包安装到您的项目中，请通过composer添加以下片段到您的composer.json文件。然后运行composer install。

"require": {
    "travail/log-buffered": "dev-master"
}

如果要从GitHub安装，请添加以下内容

"repositories": [
    {
        "type": "vcs",
        "url": "git@github.com:travail/php-Log-Buffered.git"
    }
]

依赖关系

Log\Buffered依赖于以下

• Log\Minimal

方法

__construct

__constract(array $attrs)

参数

$attrs可以包含以下键

file

日志记录器写入的文件的路径。

color

如果设置为true，则输出彩色消息，默认为false。

debug

如果设置为true，则输出调试消息，默认为false。

log_level

日志级别的下限。默认为info。注意：要输出调试消息，请将debug设置为log_level，并将debug设置为true。

trace_level

堆栈跟踪的深度。默认为1。

buffer_size

设置允许在给定大小内缓冲消息的缓冲区大小。默认为5120 bytes。您必须指定此值在Log\Buffered::MIN_BUFFER_SIZE和Log\Buffered::MAX_BUFFER_SIZE之间，否则将抛出异常。

debugf

void debugf(string $format [, mixed $val [, mixed ...]])

infof

void infof(string $format [, mixed $val [, mixed ...]])

warnf

void infof(string $format [, mixed $val [, mixed ...]])

critf

void infof(string $format [, mixed $val [, mixed ...]])

上述方法将消息缓冲，直到缓冲的消息达到您指定的buffer_size。如果尝试缓冲超过buffer_size的消息，则记录器将自动以以下警告方式刷新缓冲的消息。

***************************** CAUTION!!! **********************************
Flush the buffer, because the size of buffered messages reached 1024.
If you want to buffer more messages, set the more large size to buffer_size
in the constructor or by calling Log\Buffered::setBufferSize().

参数

与内置函数sprintf相同。

append

void append(string $message)

将给定消息追加到缓冲区。通常您不需要直接使用此方法。

参数

$message

要缓冲的字符串。

flush

void flush(void)

刷新缓冲的消息。

clear

void clear(void)

清除缓冲区。

getMinBufferSize

int getMinBufferSize(void)

返回最小缓冲区大小1024字节。

getMaxBufferSize

int getMaxBufferSize(void)

返回最大缓冲区大小5120000字节。

getBufferedSize

int getBufferedSize(void)

返回缓冲消息的大小。

启用调试消息

有两种方法可以启用调试消息

1. 通过环境变量
2. 通过构造函数

通过环境变量

$_SERVER['LM_DEBUG']     = true;
$_SERVER['LM_LOG_LEVEL'] = 'debug';
$log = new Log\Buffered();
$log->debugf('This is a %s message: %s', 'debug');

通过构造函数

$log = new Log\Buffered(
    [
        'debug'     => true,
        'log_level' => 'debug',
    ]
);
$log->debugf('This is a %s message: %s', 'debug');

作者

travail

许可协议

此库是免费软件。您可以在PHP本身的相同条款下重新分发或修改它。