TheCodingMachine\GraphQL\Controllers\Cache\FileModificationTimeCacheValidatorTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	addTrackedFile()	0	3	1
A	isValid()	0	8	3

<?php


namespace TheCodingMachine\GraphQL\Controllers\Cache;

use function filemtime;

/**
 * A trait that validates a cache item based on a file modification time
 */
trait FileModificationTimeCacheValidatorTrait
{
    /**
     * An array mapping the file name to its latest modification date.
     *
     * @var array<string, int>
     */
    protected $trackedFiles = [];

    /**
     * Adds a file to track.
     * All files must not have changed for the cache to be valid.
     *
     * @param string $fileName
     */
    public function addTrackedFile(string $fileName): void
    {
        $this->trackedFiles[$fileName] = filemtime($fileName);
    }

    /**
     * Returns true if this item is valid (coming out of cache), false otherwise.
     *
     * @return bool
     */
    public function isValid(): bool
    {
        foreach ($this->trackedFiles as $fileName => $mtime) {
            if (filemtime($fileName) !== $mtime) {
                return false;
            }
        }
        return true;
    }
}