webstream-framework / Log

Outputter/FileOutputter.php

<?php

namespace WebStream\Log\Outputter;

use WebStream\Cache\Driver\ICache;

The type WebStream\Cache\Driver\ICache was not found. Maybe you did not declare it correctly or list all dependencies?

use WebStream\Cache\Driver\CacheDriverFactory;

The type WebStream\Cache\Driver\CacheDriverFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use WebStream\Container\Container;

The type WebStream\Container\Container was not found. Maybe you did not declare it correctly or list all dependencies?

use WebStream\IO\Writer\SimpleFileWriter;

The type WebStream\IO\Writer\SimpleFileWriter was not found. Maybe you did not declare it correctly or list all dependencies?

use WebStream\Log\LoggerCache;

/**
 * FileOutputter
 * @author Ryuichi Tanaka
 * @since 2016/01/26
 * @version 0.7
 */
class FileOutputter implements IOutputter, ILazyWriter
{
    /**
     * @var ICache キャッシュドライバ
     */
    private ICache $driver;

    /**
     * @var int バッファリングサイズ
     */
    private int $bufferSize;

    /**
     * @var bool 遅延書き出しフラグ
     */
    private bool $isLazyWrite;

    /**
     * @var SimpleFileWriter Writerオブジェクト
     */
    private SimpleFileWriter $writer;

    /**
     * @var LoggerCache ログキャッシュ
     */
    private LoggerCache $cache;

    /**
     * constructor
     * @param string $logPath ログファイルパス
     * @param int $bufferSize バッファリングサイズ
     */
    public function __construct(string $logPath, int $bufferSize = 1000)
    {
        $config = new Container(false);
        $config->classPrefix = "logger_cache";
        $factory = new CacheDriverFactory();
        $driver = $factory->create("WebStream\Cache\Driver\Apcu", $config);

        // LoggerCacheの中ではログは取らない
        $driver->inject('logger', new class ()
        {
            public function __call($name, $args)
            {
            }
        });
        $this->driver = $driver;
        $this->bufferSize = $bufferSize;
        $this->enableLazyWrite();
        $this->writer = new SimpleFileWriter($logPath);
    }

    /**
     * destructor
     */
    public function __destruct()
    {
        try {
            if ($this->isLazyWrite) {
                $this->writeLog(implode("", $this->cache->get()));
            }
        } catch (\Exception $ignore) {
            // デストラクタで例外が発生すると致命的なエラーとなる
        }
    }

    /**
     * {@inheritdoc}
     */
    public function enableLazyWrite()
    {
        if ($this->driver !== null) {
            $this->isLazyWrite = true;
            $this->cache = new LoggerCache($this->driver);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function enableDirectWrite()
    {
        if ($this->isLazyWrite && $this->cache->length() > 0) {
            $this->writeLog(implode("", $this->cache->get()));
        }

        $this->isLazyWrite = false;
        unset($this->cache);
    }

    /**
     * {@inheritdoc}
     */
    public function write(string $message)
    {
        if ($this->isLazyWrite) {
            if ($this->cache->length() >= $this->bufferSize) {
                $this->flush();
                $this->cache->clear();
            }
            $this->cache->add($message);
        } else {
            $this->writeLog($message);
        }
    }

    /**
     * バッファをログ出力する
     */
    private function flush()
    {
        if ($this->isLazyWrite && $this->cache->length() > 0) {
            $this->writeLog(implode("", $this->cache->get()));
        }
    }

    /**
     * ログファイルに書き出す
     * @param string $message ログメッセージ
     */
    private function writeLog(string $message)
    {
        $this->writer->write($message);
    }
}