<?php
/*
 * sysPass
 *
 * @author nuxsmin
 * @link https://syspass.org
 * @copyright 2012-2023, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass 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.
 *
 * sysPass 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 sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Infrastructure\File;

/**
 * Interface FileStorageInterface
 *
 * @package SP\Infrastructure\File;
 */
interface FileCacheInterface
{
    /**
     * Load file data unserializing the data
     *
     * @param  string|null  $path  The path to the file
     * @param  string|null  $class  The class to unserialize the data
     *
     * @return mixed
     * @throws \SP\Infrastructure\File\FileException
     */
    public function load(?string $path = null, ?string $class = null): mixed;

    /**
     * Save file data serializing the data
     *
     * @throws FileException
     */
    public function save(mixed $data, ?string $path = null): FileCacheInterface;

    public function delete(): FileCacheInterface;

    /**
     * Returns whether the file is expired
     */
    public function isExpired(int $time = 86400): bool;

    /**
     * Returns if the file is expired comparing against a reference date
     *
     * @throws FileException
     */
    public function isExpiredDate(int $date): bool;

    public function exists(): bool;
}