polderknowledge / log-module

src/Monolog/Handler/CachedInterval.php

<?php
/**
 * Polder Knowledge / log-module (https://polderknowledge.com)
 *
 * @link https://github.com/polderknowledge/log-module for the canonical source repository
 * @copyright Copyright (c) 2016-2017 Polder Knowledge (https://polderknowledge.com)
 * @license https://github.com/polderknowledge/log-module/blob/master/LICENSE.md MIT
 */

namespace PolderKnowledge\LogModule\Monolog\Handler;

use DateTime;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\Handler\HandlerInterface;
use Monolog\Logger;

final class CachedInterval extends AbstractProcessingHandler
{
    /**
     * The handler to call when flushing.
     *
     * @var HandlerInterface
     */
    private $handler;

    /**
     * The interval in seconds before the cache is flushed.
     *
     * @var int
     */
    private $interval;

    /**
     * The path to the file which should be used to cache the records.
     *
     * @var string
     */
    private $store;

    /**
     * Initializes a new instance of this class.
     *
     * @param HandlerInterface $handler
     * @param int $interval
     * @param string $store
     * @param int $level
     * @param bool $bubble
     */
    public function __construct(
        HandlerInterface $handler,
        int $interval,
        string $store = null,
        int $level = Logger::DEBUG,
        bool $bubble = true
    ) {
        parent::__construct($level, $bubble);

        $this->handler = $handler;
        $this->interval = $interval;
        $this->store = $store ?? sys_get_temp_dir() . '/monolog-cachedinterval-' . substr(md5(__FILE__), 0, 20) .'.log';
    }

    /**
     * Writes the record down to the log of the implementing handler
     *
     * @param  array $record
     * @return void
     */
    protected function write(array $record)
    {
        // Remove the formatted context, it's not relevant for us.
        unset($record['formatted']);

        if ($this->isExpired()) {
            $this->flush();
        } else {
            $this->appendLog($record);
        }
    }

    private function isExpired()
    {
        if (!file_exists($this->store)) {
            return false;
        }

        $lines = file($this->store);

        if (!$lines) {

The expression $lines of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return false;
        }

        $log = unserialize($lines[0]);

        /** @var DateTime $logDate */
        $logDate = $log['datetime'];

        return $logDate->getTimestamp() + $this->interval < time();
    }

    private function flush()
    {
        $lines = file($this->store);

        $logs = [];

        foreach ($lines as $line) {
            $logs[] = unserialize($line);
        }

        $this->handler->handleBatch($logs);

        unlink($this->store);
    }

    private function appendLog(array $record)
    {
        file_put_contents($this->store, serialize($record) . "\n", FILE_APPEND);
    }
}