travail/log-buffered

travail/log-buffered

Log\Beffered

NAME

Log\Buffered -, _(*1)

SYNOPSIS

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

INSTALLATION

To install this package into your project via composer, add the following snippet to your composer.json. Then run composer install., _(*2)

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

If you want to install from gihub, add the following:, _(*3)

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

DEPENDENCIES

Log\Buffered has the dependency on the following:, _(*4)

• Log\Minimal

METHODS

__construct

__constract(array $attrs), _(*5)

Parameters

$attrs can contain the keys below:, _(*6)

file

Path to a file into which logger writes., _(*7)

color

Outputs colored messages if set a true value, false by default., _(*8)

debug

Outputs debug messages if set a true value, false by default., _(*9)

log_level

The lower limit of the log level. info by default. NOTE: To output debug messages set debug to log_level and a true value to debug., _(*10)

trace_level

The depth of stack trace. 1 by default., _(*11)

buffer_size

Set the size of buffer which allow to buffer messages within given size. 5120 bytes by default. You must specify this between Log\Buffered::MIN_BUFFER_SIZE and Log\Buffered::MAX_BUFFER_SIZE, or an Exception will be thrown., _(*12)

debugf

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

infof

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

warnf

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

critf

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

These methods above buffer messages until buffered messages reach buffer_size you specified. If you try to buffer messages more than buffer_size the logger will flush buffered messages automatically with the caution below., _(*17)

***************************** 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().

Parameters

The same as the built-in function sprintf., _(*18)

append

void append(string $message), _(*19)

Append a given message to the buffer. Usually you don't have to use this directly., _(*20)

Parameters

$message

A string to be buffered., _(*21)

flush

void flush(void), _(*22)

Flush buffered messages., _(*23)

clear

void clear(void), _(*24)

Clear the buffer., _(*25)

getMinBufferSize

int getMinBufferSize(void), _(*26)

Returns the size of min buffer size 1024 bytes., _(*27)

getMaxBufferSize

int getMaxBufferSize(void), _(*28)

Returns the size of max buffer size 5120000 bytes., _(*29)

getBufferedSize

int getBufferedSize(void), _(*30)

Returns the size of buffered messages., _(*31)

ENABLING DEBUG MESSAGES

There are two ways to enable debug messages:, _(*32)

1. By Environment Values
2. By Constructor

By Environment Values

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

By Constructor

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

AUTHOR

travail, _(*33)

LICENSE

This library is free software. You can redistribute it and/or modify it under the same terms as PHP itself., _(*34)