Platine\Template\Cache\AbstractCache

Complexity

Total Complexity

1

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1

<?php

/**
 * Platine Template
 *
 * Platine Template is a template engine that has taken a lot of inspiration from Django.
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Template
 * Copyright (c) 2014 Guz Alexander, http://guzalexander.com
 * Copyright (c) 2011, 2012 Harald Hanek, http://www.delacap.com
 * Copyright (c) 2006 Mateo Murphy
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file AbstractCache.php
 *
 *  The Template cache base class
 *
 *  @package    Platine\Template\Cache
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Template\Cache;

use Platine\Template\Configuration;

/**
 * @class AbstractCache
 * @package Platine\Template\Cache
 */
abstract class AbstractCache
{
    /**
     * The cache expiration in second
     * @var int
     */
    protected int $expire = 3600;

    /**
     * The cache prefix to use
     * @var string
     */
    protected string $prefix = '__template';

    /**
     * The configuration instance
     * @var Configuration
     */
    protected Configuration $config;

    /**
     * Create new instance
     * @param Configuration|null $config
     */
    public function __construct(?Configuration $config = null)
    {
        $this->config = $config ?? new Configuration([]);

        $this->expire = $this->config->get('cache_expire');
        $this->prefix = $this->config->get('cache_prefix');
    }

    /**
     * Return the cache stored value
     * @param string $key
     * @param bool $unserialize
     * @return mixed
     */
    abstract public function read(string $key, bool $unserialize = true): mixed;

    /**
     * Whether the cache exists
     * @param string $key
     * @return bool
     */
    abstract public function exists(string $key): bool;

    /**
     * Save the cache data
     * @param string $key
     * @param mixed $value
     * @param bool $serialize
     * @return bool
     */
    abstract public function write(string $key, mixed $value, bool $serialize = true): bool;


    /**
     * Delete all cache data
     * @param bool $expired
     * @return bool
     */
    abstract public function flush(bool $expired = false): bool;
}