Romm\ConfigurationObject\Core\Service\CacheService

Complexity

Total Complexity

9

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	registerInternalCache()	0	5	1
A	registerDynamicCaches()	0	11	2
A	registerDynamicCache()	0	15	2
A	registerCacheInternal()	0	8	2
A	getCache()	0	4	1
A	getCacheManager()	0	7	1

<?php
/*
 * 2017 Romain CANON <romain.hydrocanon@gmail.com>
 *
 * This file is part of the TYPO3 Configuration Object project.
 * It is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, either
 * version 3 of the License, or any later version.
 *
 * For the full copyright and license information, see:
 * http://www.gnu.org/licenses/gpl-3.0.html
 */

namespace Romm\ConfigurationObject\Core\Service;

use TYPO3\CMS\Core\Cache\Backend\FileBackend;
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use TYPO3\CMS\Core\Cache\Frontend\VariableFrontend;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class CacheService implements SingletonInterface
{
    const CACHE_IDENTIFIER = 'cache_configuration_object';
    const CACHE_TAG_DYNAMIC_CACHE = 'dynamic-cache';

    /**
     * Options for the internal cache.
     *
     * @var array
     */
    protected $cacheOptions = [
        'backend'  => FileBackend::class,
        'frontend' => VariableFrontend::class,
        'groups'   => ['all', 'system']
    ];

    /**
     * Function called from `ext_localconf` file which will register the
     * internal cache earlier.
     *
     * @internal
     */
    public function registerInternalCache()
    {
        $this->getCacheManager()
            ->setCacheConfigurations([self::CACHE_IDENTIFIER => $this->cacheOptions]);
    }

    /**
     * This function will take care of initializing all caches that were defined
     * previously  by the `CacheService` which allows dynamic caches to be used
     * for every configuration object type.
     *
     * @see \Romm\ConfigurationObject\Service\Items\Cache\CacheService::initialize()
     * @internal
     */
    public function registerDynamicCaches()
    {
        $dynamicCaches = $this->getCache()->getByTag(self::CACHE_TAG_DYNAMIC_CACHE);

        foreach ($dynamicCaches as $cacheData) {
            $identifier = $cacheData['identifier'];
            $options = $cacheData['options'];

            $this->registerCacheInternal($identifier, $options);
        }
    }

    /**
     * Registers a new dynamic cache: the cache will be added to the cache
     * manager after this function is executed. Its configuration will also be
     * remembered so the cache will be registered properly during the cache
     * framework initialization in further requests.
     *
     * @param string $identifier
     * @param array  $options
     */
    public function registerDynamicCache($identifier, array $options)
    {
        if (false === $this->getCache()->has($identifier)) {
            $this->getCache()->set(
                $identifier,
                [
                    'identifier' => $identifier,
                    'options'    => $options
                ],
                [self::CACHE_TAG_DYNAMIC_CACHE]
            );
        }

        $this->registerCacheInternal($identifier, $options);
    }

    /**
     * @param string $identifier
     * @param array  $options
     */
    protected function registerCacheInternal($identifier, array $options)
    {
        $cacheManager = $this->getCacheManager();

        if (false === $cacheManager->hasCache($identifier)) {
            $cacheManager->setCacheConfigurations([$identifier => $options]);
        }
    }

    /**
     * @return FrontendInterface
     */
    protected function getCache()
    {
        return $this->getCacheManager()->getCache(self::CACHE_IDENTIFIER);
    }

    /**
     * @return CacheManager
     */
    protected function getCacheManager()
    {
        /** @var CacheManager $cacheManager */
        $cacheManager = GeneralUtility::makeInstance(CacheManager::class);

        return $cacheManager;
    }
}