Silviooosilva\CacheerPhp\CacheStore\CacheManager\GenericFlusher

Complexity

Total Complexity

7

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	handleAutoFlush()	0	6	2
A	scheduleFlush()	0	14	3
A	flushCache()	0	4	1

<?php

namespace Silviooosilva\CacheerPhp\CacheStore\CacheManager;

use Silviooosilva\CacheerPhp\Helpers\CacheFileHelper;

/**
 * Class GenericFlusher
 *
 * @author Sílvio Silva <https://github.com/silviooosilva>
 * @package Silviooosilva\CacheerPhp
 * 
 * Lightweight flusher that stores last flush timestamp in a file and invokes a provided callback.
 */
class GenericFlusher
{
    /** @var string */
    private string $lastFlushTimeFile;

    /** @var callable */
    private $flushCallback;

    /**
     * @param string   $lastFlushTimeFile
     * @param callable $flushCallback  Callback that performs the actual flush
     */
    public function __construct(string $lastFlushTimeFile, callable $flushCallback)
    {
        $this->lastFlushTimeFile = $lastFlushTimeFile;
        $this->flushCallback = $flushCallback;
    }

    /**
     * Performs a flush and records the time.
     * @return void
     */
    public function flushCache(): void
    {
        ($this->flushCallback)();
        @file_put_contents($this->lastFlushTimeFile, (string) time());

It seems like you do not handle an error condition for file_put_contents(). This can introduce security issues, and is generally not recommended.

    }

    /**
     * Handles auto-flush if 'flushAfter' is present in options.
     * @param array $options
     * @return void
     */
    public function handleAutoFlush(array $options): void
    {
        if (!isset($options['flushAfter'])) {
            return;
        }
        $this->scheduleFlush((string) $options['flushAfter']);
    }

    /**
     * @param string $flushAfter
     * @return void
     */
    private function scheduleFlush(string $flushAfter): void
    {
        $flushAfterSeconds = (int) CacheFileHelper::convertExpirationToSeconds($flushAfter);

        if (!file_exists($this->lastFlushTimeFile)) {
            @file_put_contents($this->lastFlushTimeFile, (string) time());

It seems like you do not handle an error condition for file_put_contents(). This can introduce security issues, and is generally not recommended.

            return;
        }

        $lastFlushTime = (int) @file_get_contents($this->lastFlushTimeFile);

        if ((time() - $lastFlushTime) >= $flushAfterSeconds) {
            $this->flushCache();
            @file_put_contents($this->lastFlushTimeFile, (string) time());
        }
    }
}