xref: /webtrees/app/Factories/CacheFactory.php (revision e873f434551745f888937263ff89e80db3b0f785)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2023 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Factories;

use Fisharebest\Webtrees\Cache;
use Fisharebest\Webtrees\Contracts\CacheFactoryInterface;
use Fisharebest\Webtrees\Webtrees;
use Symfony\Component\Cache\Adapter\ArrayAdapter;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

use function random_int;

/**
 * Make a cache.
 */
class CacheFactory implements CacheFactoryInterface
{
    // How frequently to perform garbage collection.
    private const int GC_PROBABILITY = 1000;

    // Filesystem cache parameters.
    private const int    FILES_TTL = 8640000;
    private const string FILES_DIR = Webtrees::DATA_DIR . 'cache/';

    private ArrayAdapter $array_adapter;

    private FilesystemAdapter $filesystem_adapter;

    /**/
    public function __construct()
    {
        $this->array_adapter      = new ArrayAdapter(0, false);
        $this->filesystem_adapter = new FilesystemAdapter('', self::FILES_TTL, self::FILES_DIR);
    }

    /**
     * Create an array-based cache.
     *
     * @return Cache
     */
    public function array(): Cache
    {
        return new Cache($this->array_adapter);
    }

    /**
     * Create an file-based cache.
     *
     * @return Cache
     */
    public function file(): Cache
    {
        return new Cache($this->filesystem_adapter);
    }

    /**
     * Perform garbage collection.
     */
    public function __destruct()
    {
        if (random_int(1, self::GC_PROBABILITY) === 1) {
            $this->filesystem_adapter->prune();
        }
    }
}