bedita / bedita

plugins/BEdita/Core/src/Cache/Engine/LayeredEngine.php

<?php
/**
 * BEdita, API-first content management framework
 * Copyright 2021 ChannelWeb Srl, Chialab Srl
 *
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * See LICENSE.LGPL or <http://gnu.org/licenses/lgpl-3.0.html> for more details.
 */
namespace BEdita\Core\Cache\Engine;

use Cake\Cache\Cache;
use Cake\Cache\CacheEngine;
use Cake\Cache\Engine\ArrayEngine;
use Exception;

/**
 * This engine uses two layers of cache, one persistent and one in-memory for faster lookup times.
 */
class LayeredEngine extends CacheEngine
{
    /**
     * Persistent cache instance.
     *
     * @var \Cake\Cache\CacheEngine
     */
    protected $persistent = null;

    /**
     * In-memory cache instance.
     *
     * @var \Cake\Cache\Engine\ArrayEngine
     */
    protected $memory = null;

    /**
     * The default config used unless overridden by runtime configuration
     *
     * - `persistent` A cache configuration or an alias, to use as persistent cache
     *
     * @var array
     */
    protected $_defaultConfig = [
        'duration' => 3600,
        'groups' => [],
        'prefix' => 'cake_',
        'probability' => 100,
        'warnOnWriteFailures' => true,
        'persistent' => [
            'className' => 'File',
        ],
    ];

    /**
     * {@inheritDoc}
     *
     * @throws \Exception If the configuration is wrong
     */
    public function init(array $config = []): bool
    {
        parent::init($config);

        $this->persistent = $this->getEngineInstance($this->getConfig('persistent'));
        $this->memory = new ArrayEngine();
        $this->memory->setConfig($this->getConfig());

        return true;
    }

    /**
     * Get the engine instance from a configuration or an alias.
     *
     * @param array|string $config Engine configuration or an alias
     * @return \Cake\Cache\CacheEngine The engine instance
     * @throws \Exception If the configuration is wrong
     */
    protected function getEngineInstance($config): CacheEngine
    {
        $registry = Cache::getRegistry();

        if (is_string($config)) {
            if (!$registry->has($config)) {
                throw new Exception("Cache engine alias '{$config}' is not defined");
            }

            $instance = $registry->get($config);

            if ($instance === $this) {
                throw new Exception('Recursion detected, Layered cache engine is configured as persistent engine of itself');
            }

            if (!($instance instanceof CacheEngine)) {
                throw new Exception("Cache engine alias '{$config}' is not an implementation of CacheEngine");
            }

            return $instance;
        }

        if (is_array($config)) {

The condition is_array($config) is always true.

            $name = $config['className'];

            if (!empty($config['prefix'])) {
                $name = $config['prefix'] . $name;
            }

            return $registry->load($name, $config);
        }

        throw new Exception('Unknown cache configuration');
    }

    /**
     * @inheritDoc
     */
    public function write($key, $value): bool
    {
        $this->memory->write($key, $value);

        return $this->persistent->write($key, $value);
    }

    /**
     * @inheritDoc
     */
    public function read($key)
    {
        $value = $this->memory->read($key);

        if ($value !== false) {
            return $value;
        }

        $value = $this->persistent->read($key);
        $this->memory->write($key, $value);

        return $value;
    }

    /**
     * @inheritDoc
     */
    public function increment($key, $offset = 1)
    {
        $value = $this->persistent->increment($key, $offset);
        $this->memory->write($key, $value);

        return $value;
    }

    /**
     * @inheritDoc
     */
    public function decrement($key, $offset = 1)
    {
        $value = $this->persistent->decrement($key, $offset);
        $this->memory->write($key, $value);

        return $value;
    }

    /**
     * @inheritDoc
     */
    public function delete($key): bool
    {
        $this->memory->delete($key);

        return $this->persistent->delete($key);
    }

    /**
     * @inheritDoc
     */
    public function clear($check): bool
    {
        $this->memory->clear($check);

        return $this->persistent->clear($check);
    }
}