README

Yii Logging Library - File Target

This package provides the File target for the yiisoft/log. The target:

The package could be installed with composer:

composer require yiisoft/log-target-file --prefer-dist

Creating a rotator:

$rotator = new \Yiisoft\Log\Target\File\FileRotator(
    $maxFileSize,
    $maxFiles,
    $fileMode,
    $compressRotatedFiles
);

$maxFileSize (int) - The maximum file size, in kilo-bytes. Defaults to 10240, meaning 10MB.
$maxFiles (int) - The number of files used for rotation. Defaults to 5.
$fileMode (int|null) - The permission to be set for newly created files. Defaults to null.
$compressRotatedFiles (bool) - Whether to compress rotated files with gzip. Defaults to false.

Creating a target:

$fileTarget = new \Yiisoft\Log\Target\File\FileTarget(
    $logFile,
    $rotator,
    $dirMode,
    $fileMode
);

$logFile (string) - The log file path. Defaults to /tmp/app.log.
$rotator (\Yiisoft\Log\Target\File\FileRotatorInterface|null) - Defaults to null, which means that log files will not be rotated.
$dirMode (int) - The permission to be set for newly created directories. Defaults to 0775.
$fileMode (int|null) - The permission to be set for newly created log files. Defaults to null.

Creating a logger:

$logger = new \Yiisoft\Log\Logger([$fileTarget]);

For a description of using the logger, see the yiisoft/log package.

For use in the Yii framework, see the configuration files:

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

The package tests are checked with Infection mutation framework. To run it:

./vendor/bin/infection

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

The Yii Logging Library - File Target is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.