AbstractFrontend.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Cache\Frontend;
 
use ‪TYPO3\CMS\Core\Cache\Backend\AbstractBackend;
use ‪TYPO3\CMS\Core\Cache\Backend\BackendInterface;
use ‪TYPO3\CMS\Core\Cache\Backend\TaggableBackendInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractFrontend implements ‪FrontendInterface
{
    protected ‪$identifier;
 
    protected ‪$backend;
 
    public function ‪__construct(‪$identifier, ‪BackendInterface ‪$backend)
    {
        if (preg_match(self::PATTERN_ENTRYIDENTIFIER, ‪$identifier) !== 1) {
            throw new \InvalidArgumentException('"' . ‪$identifier . '" is not a valid cache identifier.', 1203584729);
        }
        if (strpos(‪$identifier, 'cache_') === 0) {
            trigger_error('Setting up a cache as in "' . ‪$identifier . '" with the "cache_" prefix is not necessary anymore, and should be called without the cache prefix.', E_USER_DEPRECATED);
            ‪$identifier = substr(‪$identifier, 6);
        }
        $this->identifier = ‪$identifier;
        $this->backend = ‪$backend;
        $this->backend->‪setCache($this);
    }
 
    public function ‪getIdentifier()
    {
        return ‪$this->identifier;
    }
 
    public function ‪getBackend()
    {
        return ‪$this->backend;
    }
 
    public function ‪has($entryIdentifier)
    {
        if (!$this->‪isValidEntryIdentifier($entryIdentifier)) {
            throw new \InvalidArgumentException('"' . $entryIdentifier . '" is not a valid cache entry identifier.', 1233058486);
        }
        return $this->backend->has($entryIdentifier);
    }
 
    public function remove($entryIdentifier)
    {
        if (!$this->‪isValidEntryIdentifier($entryIdentifier)) {
            throw new \InvalidArgumentException('"' . $entryIdentifier . '" is not a valid cache entry identifier.', 1233058495);
        }
        return $this->backend->remove($entryIdentifier);
    }
 
    public function ‪flush()
    {
        $this->backend->flush();
    }
 
    public function ‪flushByTags(array $tags)
    {
        foreach ($tags as $tag) {
            if (!$this->‪isValidTag($tag)) {
                throw new \InvalidArgumentException('"' . $tag . '" is not a valid tag for a cache entry.', 1233057360);
            }
        }
        if ($this->backend instanceof ‪TaggableBackendInterface) {
            $this->backend->flushByTags($tags);
        }
    }
 
    public function ‪flushByTag($tag)
    {
        if (!$this->‪isValidTag($tag)) {
            throw new \InvalidArgumentException('"' . $tag . '" is not a valid tag for a cache entry.', 1233057359);
        }
 
        foreach (‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/cache/frontend/class.t3lib_cache_frontend_abstractfrontend.php']['flushByTag'] ?? [] as $_funcRef) {
            $params = ['tag' => $tag];
            GeneralUtility::callUserFunction($_funcRef, $params, $this);
        }
 
        if ($this->backend instanceof ‪TaggableBackendInterface) {
            $this->backend->flushByTag($tag);
        }
    }
 
    public function ‪collectGarbage()
    {
        $this->backend->collectGarbage();
    }
 
    public function ‪isValidEntryIdentifier(‪$identifier)
    {
        return preg_match(self::PATTERN_ENTRYIDENTIFIER, ‪$identifier) === 1;
    }
 
    public function ‪isValidTag($tag)
    {
        if (!is_array($tag)) {
            return preg_match(self::PATTERN_TAG, $tag) === 1;
        }
        foreach ($tag as $tagValue) {
            if (!$this->‪isValidTag($tagValue)) {
                return false;
            }
        }
        return true;
    }
}